SIGMATECH logo
API docs by Redocly

CASYMIR REST API (latest)

Download OpenAPI specification:

CASYMIR Support: support@casymir.com URL: https://www.sigmatech.de/kontakt/
Visit CASYMIR

Introduction

The CASYMIR REST API provides a restful developing interface for external services. It's built on HTTP and fully supports HATEOAS. JSON is the default request and response format.
This document describes the functionality of the provided resources.

Note: If you don't have the correct uri or you need an user account please contact your contact person.

/token

Get an access token

In exchange for the client credentials, the resource returns an access token with a finite lifetime.

Authorizations:
basicAuthoAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "access_token": "76e60f809eac96fb3bddf2e87315e572069b9c47",
  • "expires_in": 360
}

Get an access token Deprecated

In exchange for the client credentials, the resource returns an access token with a finite lifetime.

Authorizations:
basicAuthoAuth2ClientCredentials
Request Body schema: application/x-www-form-urlencoded
required

The body must have following structure.

grant_type
required
string
Value: "client_credentials"

Responses

Request samples

Content type
application/x-www-form-urlencoded
grant_type=client_credentials

Response samples

Content type
application/json
{
  • "access_token": "6ceb7ce10b6ed5524a66eaf7dd3e9a7f372a8222",
  • "token_type": "bearer",
  • "expires_in": 3600
}

/addresses

Address operations

List addresses

NOT IMPLEMENTED NOW
Returns the desired addresses.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

Creates an address

NOT IMPLEMENTED NOW
Creates an address and returns the address id.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
Any of
companyLine1
required
string (companyLine1) <= 36 characters

Company name of an address line 1

companyLine2
string (companyLine2) <= 36 characters

Company name of an address line 2

addressId
integer (addressId)

Number of the address

addressLine1
required
string (addressLine1) <= 60 characters

Line 1 of an address for street and house number

addressLine2
string (addressLine2) <= 60 characters

Line 2 of an address for additional information

languageId
string (languageId) <= 4 characters

Id of a language

phone
string (phone) <= 40 characters

Phone number of an address

fax
string (fax) <= 40 characters

Fax number of an address

mobilePhone
string (mobilePhone) <= 40 characters

Mobile phone number of an address

email
string (email) <= 255 characters

email address

entryDate
string <date-time> (entryDate) = 20 characters

Date of entry

entryBy
string (entryBy) <= 12 characters

User who captured

changeDate
string <date-time> (changeDate) = 20 characters

Date of the latest editing

changeBy
string (changeBy) <= 12 characters

User who last edited

comment
string (comment) <= 255 characters

Comment

countryId
required
string (countryId) <= 4 characters

Internal id of a country

city
required
string (city) <= 48 characters

City name

postCode
required
string (postCode) <= 10 characters

Post code of a city

salutationId
integer (salutationId)

Id of the salutation

forceAddressId
boolean
Default: false

Force addressId to be set, only for create operations.

Responses

Request samples

Content type
application/json
Example
{
  • "companyLine1": "string",
  • "companyLine2": "string",
  • "addressId": 0,
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "languageId": "stri",
  • "phone": "string",
  • "fax": "string",
  • "mobilePhone": "string",
  • "email": "string",
  • "entryDate": "2019-08-24T14:15:22Z",
  • "entryBy": "string",
  • "changeDate": "2019-08-24T14:15:22Z",
  • "changeBy": "string",
  • "comment": "string",
  • "countryId": "stri",
  • "city": "string",
  • "postCode": "string",
  • "salutationId": 0,
  • "forceAddressId": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

List cities

Returns cities.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

changeDateFrom
string <date-time> (changeDate) = 20 characters

Filter by change date

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List delivery sections

Returns delivery sections.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

changeDateFrom
string <date-time> (changeDate) = 20 characters

Filter by change date

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

/companies

Company operations

/master

Master Data operations

List group structures of articles

Outputs the hierarchical structure of item, product and assortment groups.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List templates for article regulations

Outputs text templates to choose when creating article regulations.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List base units

Outputs available base units for articles.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List cost centers

Returns the current values and configurations of master data.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List packaging units

Outputs available packaging units for articles, in which the article can be packed in his base unit.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List printers

Returns a list of available printers in the system.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List production means

Returns the current values and configurations of master data.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

productionMeansId
string (productionMeansId) <= 12 characters

Filter by production means id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List storage locations

Returns the current values and configurations of master data.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

storageLocation
string (storageLocation) <= 12 characters

Filter by storage location

siteNo
integer (siteNo)

Filter by site number

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List users

Returns a list of valid users in the target tenant.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

scope
string
Value: "all"

Filter by scope for a more precise response.

  • all - all users in system instead of only in tenant

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

/media

Media operations

List media data

Returns media data of the specified media resource.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

mediaId
number <integer> (mediaId)

Filter by media identifier

mediaResource
string (mediaResource)
Value: "article"

Filter by media resource

articleNo
string (articleNo) <= 15 characters

Filter by article number

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List media data by identifier

Returns the desired media data.

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
mediaId
required
number <integer> (mediaId)

Id of a media data

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 1,
  • "data": [
    ]
}

/orders

Orders operations

List all kind of orders

Returns orders data that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
orderNo
string (orderNo) <= 10 characters

Filter by order number

customerId
string (customerId) <= 8 characters

Filter by customer

entryDateFrom
string <date-time> (entryDate) = 20 characters

Filter by entry date

entryDateUntil
string <date-time> (entryDate) = 20 characters

Filter by entry date

companyId
string (companyId) <= 12 characters

Filter by company

status
string (status) <= 1 characters

Filter by status

processingStatus
integer (processingStatus)
Enum: 0 1 2 3 10 11

Filter by processing status

  • 0 - Open
  • 1 - Externally completed only
  • 2 - Internally completed only
  • 3 - Completed
  • 10 - Open (Offers only)
  • 11 - Completed (Offers only)
siteNo
integer (siteNo)

Filter by site number

costUnitType
integer (costUnitType)
Enum: 0 1 2

Filter by type of cost unit

limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

scope
string
Value: "app"

Filter by scope for a more precise response.

  • app - for internal use only

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

Create an order

Creates sales or production order and returns the orderNo.
In the items list you can set orderPosSortNo for the sort order on reports. The orderPosSeqNo can be set after bilateral agreement, otherwise it will be set to the orderPosNo by default.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
customerId
required
string (customerId) <= 8 characters

Number of the customer

companyId
required
string (companyId) <= 12 characters

Id of the company

customerOrderNo
string (customerOrderNo) <= 36 characters

Order number in the customers system or orderNo in foreign order system

orderDescription
string (description)

Description to an entity

orderReference
string (orderReference) <= 60 characters

External reference to an order

comment
string (comment) <= 255 characters

Comment

costUnit
string (costUnit) <= 6 characters

Cost unit

siteNo
required
integer (siteNo)

Site number

status
string (status) <= 1 characters

Status of an entity

object (address)

Address object

object (address)

Address object

object (address)

Address object

deliveryDate
string <date-time> (deliveryDate) = 20 characters

Appointment of delivery

shippingTermId
string (shippingTermId) <= 12 characters

Id of the shipping terms and conditions

userName
string (userName) <= 12 characters

User name

personnelNo
string (personnelNo) <= 8 characters

Personnel number of an employee or asset

orderDate
string <date-time> (orderDate) = 20 characters

Date on which the order was placed

paymentTerm
number <integer> (paymentTerm) [ 0 .. 255 ]

Id of predefined payment terms

required
Array of objects (orderPositionPOST)

List of order positions

Responses

Request samples

Content type
application/json
Example
{
  • "customerId": "30008",
  • "costUnit": "100",
  • "siteNo": "1",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

/articles

Article operations

List articles

Returns all articles from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

articleNo
string (articleNo) <= 15 characters

Filter by article number

baseUnit
string (baseUnit) <= 12 characters

Filter by article base unit

articleGroup
string (articleGroup) <= 12 characters

Filter by article group

articleClass
string (articleClass) <= 8 characters

Filter by article class

processingType
string (processingType) <= 1 characters
Enum: "A" "C" "N" "S"

Filter by type of processing (A=Batch+SerialNo, C=Batch, N=Normal, S=SerialNo). Multiple values possible (processingType=CN for values C and N)

procurementType
string (procurementType) <= 1 characters

Filter by procurement type. System individually defined types. Multiple values possible (procurementType=EF for values E and F)

articleStatus
integer (articleStatus)
Enum: 0 1 2 3 4

Filter by article status (0=New, 1=Active, 2=Deleted, 3=Locked, 4=Discontinued). Multiple values possible (articleStatus=14 for values 1 and 4)

scope
string
Enum: "base" "key" "app" "extended" "all"

Filter by scope for a more precise response.

  • base - basic data only
  • key - primary key only
  • app - for internal use only

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List article by number Deprecated

Returns the desired article.

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
articleNo
required
string (articleNo) <= 15 characters

Number of the article

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 1,
  • "data": [
    ]
}

/batches

Batch operations

List article batches

Returns all article batches from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

articleNo
string (articleNo) <= 15 characters

Filter by article number

batchNo
string (batchNo) <= 24 characters

Filter by batch number

entryDateFrom
string <date-time> (entryDate) = 20 characters

Filter by entry date

entryDateUntil
string <date-time> (entryDate) = 20 characters

Filter by entry date

productionOrderNo
string (productionOrderNo) <= 10 characters

Filter by production order number

productionOrderPosNo
integer (productionOrderPosNo)

Filter by production order position number

productionDateFrom
string <date-time> (productionDate) = 20 characters

Filter by production date

productionDateUntil
string <date-time> (productionDate) = 20 characters

Filter by production date

expiryDateFrom
string <date-time> (expiryDate) = 20 characters

Filter by expiry date

expiryDateUntil
string <date-time> (expiryDate) = 20 characters

Filter by expiry date

releaseDateFrom
string <date-time> (releaseDate) = 20 characters

Filter by release date

releaseDateUntil
string <date-time> (releaseDate) = 20 characters

Filter by release date

releaseBy
string (releaseBy) <= 12 characters

Filter by releasing user

pallets
boolean

Also list pallet batches

inStockOnly
boolean

Filter by stock status

scope
string
Enum: "base" "key" "app" "extended"

Filter by scope for a more precise response.

  • base - basic data only
  • key - primary key only
  • app - for internal use only
  • extended - all available data

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

Create new batch

Creates batch and returns the batchNo.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
Any of
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

expiryDate
string <date-time> (expiryDate) = 20 characters

Expiry date

foreignBatchNo
string (foreignBatchNo) <= 24 characters

Foreign batch of the article batch

productionDate
string <date-time> (productionDate) = 20 characters

Production date

quantityTarget
number <float> (quantity)

Quantity

Responses

Request samples

Content type
application/json
Example
{
  • "articleNo": "string",
  • "batchNo": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "foreignBatchNo": "string",
  • "productionDate": "2019-08-24T14:15:22Z",
  • "quantityTarget": 0.1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Update batch

Partial update one batch entity.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

batchStatus
string (batchStatus) = 1 characters
Enum: "K" "A" "B" "E" "P" "V" "Q" "T" "M" "S" "F"

Batch status

expiryDate
string <date-time> (expiryDate) = 20 characters

Expiry date

Array of objects

List of log entries

productionDate
string <date-time> (productionDate) = 20 characters

Production date

quantityTarget
number <float> (quantity)

Quantity

Responses

Request samples

Content type
application/json
{
  • "articleNo": "string",
  • "batchNo": "string",
  • "batchStatus": "K",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "log": [
    ],
  • "productionDate": "2019-08-24T14:15:22Z",
  • "quantityTarget": 0.1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Complete production

Complete the production of this batch. This step is used after line clearance from mobile devices.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

Responses

Request samples

Content type
application/json
{
  • "articleNo": "string",
  • "batchNo": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Duplicate batch log rows Deprecated

Duplicate a batch log entry to enter a new, maybe corrected value.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

required
Array of objects

List of log row ids to duplicate

Responses

Request samples

Content type
application/json
{
  • "articleNo": "string",
  • "batchNo": "string",
  • "log": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Get planned processes

Get current and next process in production plan to a batch

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
articleNo
required
string (articleNo) <= 15 characters

Filter by article number

batchNo
required
string (batchNo) <= 24 characters

Filter by batch number

productionMeansId
required
string (productionMeansId) <= 12 characters

Filter by production means id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": {
    }
}

/ppsBatches

Batch operations - deprecated

List article batches Deprecated

Returns all article batches from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
articleNo
string (articleNo) <= 15 characters

Filter by article number

batchNo
string (batchNo) <= 24 characters

Filter by batch number

batchStatus
string (batchStatus) = 1 characters
Enum: "K" "A" "B" "E" "P" "V" "Q" "T" "M" "S" "F"

Filter by batch status

entryDateFrom
string <date-time> (entryDate) = 20 characters

Filter by entry date

entryDateUntil
string <date-time> (entryDate) = 20 characters

Filter by entry date

scheduledFrom
string <date-time> (productionDate) = 20 characters

Filter by scheduled production date

scheduledUntil
string <date-time> (productionDate) = 20 characters

Filter by scheduled production date

productionDateFrom
string <date-time> (productionDate) = 20 characters

Filter by production date

productionDateUntil
string <date-time> (productionDate) = 20 characters

Filter by production date

expiryDateFrom
string <date-time> (expiryDate) = 20 characters

Filter by expiry date

expiryDateUntil
string <date-time> (expiryDate) = 20 characters

Filter by expiry date

releaseDateFrom
string <date-time> (releaseDate) = 20 characters

Filter by release date

releaseDateUntil
string <date-time> (releaseDate) = 20 characters

Filter by release date

productionMeans
string (productionMeans) <= 12 characters

Filter by production means

articleGroup
string (articleGroup) <= 12 characters

Filter by article group

siteNo
integer (siteNo)

Filter by site number

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Book incoming products / outgoing raw materials Deprecated

Books incoming products or outgoing raw materials to a single batch, if the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
Request Body schema: application/json
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

batchStatus
string (batchStatus) = 1 characters
Enum: "K" "A" "B" "E" "P" "V" "Q" "T" "M" "S" "F"

Batch status

palletNo
integer (palletNo) <= 99999

Pallet number

storageLocation
string (storageLocation) <= 12 characters

Name of the storage location

producedAmount
number <float> (producedAmount)

The produced amount

rejectedAmount
number <float> (rejectedAmount)

The rejected amount

baseUnit
string (baseUnit) <= 12 characters

Base unit of the article

productionMeans
string (productionMeans) <= 12 characters

Production means

timeAmountHours
number <float> (timeAmountHours)

Time spent in hours

timeAmountMinutes
number <float> (timeAmountMinutes)

Time spent in minutes

materialArticleNo
string (articleNo) <= 15 characters

Number of the article

materialBatchNo
string (batchNo) <= 24 characters

Batch of the article

materialAmount
number <float> (materialAmount)

The material amount

materialRejectedAmount
number <float> (rejectedAmount)

The rejected amount

Responses

Request samples

Content type
application/json
Example
{
  • "articleNo": "C201",
  • "batchNo": "12345",
  • "palletNo": 3,
  • "storageLocation": "ff",
  • "producedAmount": 100
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Book incoming products / outgoing raw materials (batch) Deprecated

Books incoming products or outgoing raw materials to several batches, if the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
Request Body schema: application/json
Array
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

batchStatus
string (batchStatus) = 1 characters
Enum: "K" "A" "B" "E" "P" "V" "Q" "T" "M" "S" "F"

Batch status

palletNo
integer (palletNo) <= 99999

Pallet number

storageLocation
string (storageLocation) <= 12 characters

Name of the storage location

producedAmount
number <float> (producedAmount)

The produced amount

rejectedAmount
number <float> (rejectedAmount)

The rejected amount

baseUnit
string (baseUnit) <= 12 characters

Base unit of the article

productionMeans
string (productionMeans) <= 12 characters

Production means

timeAmountHours
number <float> (timeAmountHours)

Time spent in hours

timeAmountMinutes
number <float> (timeAmountMinutes)

Time spent in minutes

materialArticleNo
string (articleNo) <= 15 characters

Number of the article

materialBatchNo
string (batchNo) <= 24 characters

Batch of the article

materialAmount
number <float> (materialAmount)

The material amount

materialRejectedAmount
number <float> (rejectedAmount)

The rejected amount

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

/productionOrders

Production order operations

List all production orders

Returns production orders data that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
orderNo
string (orderNo) <= 10 characters

Filter by order number

customerId
string (customerId) <= 8 characters

Filter by customer

entryDateFrom
string <date-time> (entryDate) = 20 characters

Filter by entry date

entryDateUntil
string <date-time> (entryDate) = 20 characters

Filter by entry date

status
string (status) <= 1 characters

Filter by status

processingStatus
integer (processingStatus)
Enum: 0 1 2 3 10 11

Filter by processing status

  • 0 - Open
  • 1 - Externally completed only
  • 2 - Internally completed only
  • 3 - Completed
  • 10 - Open (Offers only)
  • 11 - Completed (Offers only)
siteNo
integer (siteNo)

Filter by site number

limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

/suppliers

List suppliers

Returns all suppliers from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

supplierId
string (supplierId) <= 8 characters

Filter by supplier

companyId
string (companyId) <= 12 characters

Filter by company

companyClassId
string (companyClassId) <= 12 characters

Filter by company class

fieldOfInterestId
string (fieldOfInterestId) <= 12 characters

Filter by field of interest

attributeKey
string (attributeKey) <= 12 characters

Filter by company attribute

attributeValue
string (attributeValue) <= 200 characters

Filter by company attribute value

globalLocationNumber
string (globalLocationNumber) <= 13 characters

Filter by GLN (EDI)

ediPartnerId
string (ediPartnerId) <= 200 characters

Filter by EDI partner id

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

/purchaseOrders

Purchase order operations

List all purchase orders

Returns purchase orders data that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
orderNo
integer (purchaseOrderNo)

Filter by order number

supplierId
string (supplierId) <= 8 characters

Filter by supplier

status
string (purchaseOrderStatus)
Enum: "completed" "created" "dispatched" "open"

Filter by purchase order status

orderScope
string (purchaseOrderScope)
Enum: "all" "external" "internal" "outstanding"

Filter by purchase order predefined scopes

type
string (purchaseOrderType)
Enum: "order" "contract" "return" "offer" "framework" "request"

Filter by purchase order type

limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

Create a purchase order

Creates purchase order and returns the orderNo.
In the items list you can set orderPosSortNo for the sort order on reports. The orderPosSeqNo can be set after bilateral agreement, otherwise it will be set to the orderPosNo by default.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
object (address)

Address object

deliveryDate
string <date-time> (deliveryDate) = 20 characters

Appointment of delivery

description
string (description)

Description to an entity

required
Array of objects (purchaseOrderPositionPOST)

List of purchase order positions

object (address)

Address object

orderDate
string <date-time> (orderDate) = 20 characters

Date on which the order was placed

object (address)

Address object

companyId
required
string (companyId) <= 12 characters

Id of the company

supplierId
required
string (supplierId) <= 8 characters

Id of the supplier

supplierOrderNo
string (supplierOrderNo) <= 255 characters

Foreign order number of purchase order

Responses

Request samples

Content type
application/json
{
  • "supplierId": "30008",
  • "siteNo": "1",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

/label

Label printing operations

Print article labels

Prints predefined types of labels for the given articles.

Authorizations:
basicAuthoAuth2ClientCredentials
Request Body schema: application/json
articleNo
string (articleNo) <= 15 characters

Number of the article

batchNo
string (batchNo) <= 24 characters

Batch of the article

quantity
number <float> (quantity)

Quantity

labelType
number <integer> (labelType)

Type of predefined article label

numberOfLabels
number <integer> (numberOfLabels)

Number of labels to be printed

printerName
string (printerName) <= 64 characters

Queue name of the printer

siteNo
integer (siteNo)

Site number

storageLocation
string (storageLocation) <= 12 characters

Name of the storage location

Responses

Request samples

Content type
application/json
Example
{
  • "articleNo": "P201",
  • "batchNo": "10060",
  • "numberOfLabels": 1,
  • "printerName": "Zebra1"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0
}

/customers

Customer operations

List customers

Returns all customers from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

customerId
string (customerId) <= 8 characters

Filter by customer

customerIdList
string (customerIdList)

Filter by a list comma seperated list of customer

industryId
string (industryId) <= 12 characters

Filter by industry

companyId
string (companyId) <= 12 characters

Filter by company

companyClassId
string (companyClassId) <= 12 characters

Filter by company class

fieldOfInterestId
string (fieldOfInterestId) <= 12 characters

Filter by field of interest

attributeKey
string (attributeKey) <= 12 characters

Filter by company attribute

attributeValue
string (attributeValue) <= 200 characters

Filter by company attribute value

attributesValidFrom
string
Enum: "all" "current"

Filter company attributes by validity

globalLocationNumber
string (globalLocationNumber) <= 13 characters

Filter by GLN (EDI)

ediPartnerId
string (ediPartnerId) <= 200 characters

Filter by EDI partner id

scope
string
Enum: "base" "key" "app"

Filter by scope for a more precise response.

  • base - basic data only
  • key - primary key only
  • app - for internal use only

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

Create new customer

Creates customer and returns the customerId.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
customerId
string (customerId) <= 8 characters

Number of the customer

customerName
string (customerName) <= 24 characters

Short name of a customer

required
Company name (object) or Personal name (object) or Both names (object) (addressPOST)

Address object (request)

Company name (object) or Personal name (object) or Both names (object) (addressPOST)

Address object (request)

Company name (object) or Personal name (object) or Both names (object) (addressPOST)

Address object (request)

Array of objects (attributePUT)

Attribute array (request)

customerGroupId
integer (customerGroupId)

Id of the customer group

paymentTerm
number <integer> (paymentTerm) [ 0 .. 255 ]

Id of predefined payment terms

Responses

Request samples

Content type
application/json
Example
{
  • "contactAddress": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

/customerAttributes

Customer attribute operations - deprecated

Create or update attributes by customer Deprecated

Returns the saved attributes with validity date.

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
customerId
required
string (customerId) <= 8 characters

Number of the customer

Request Body schema: application/json
Array
attributeKey
string (attributeKey) <= 12 characters

Attribute key

attributeValue
string (attributeValue) <= 200 characters

Attribute value

validFrom
string <date-time> (validFrom) = 20 characters

Date the attribute is valid from

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

/salesOrders

Sales order operations

List all sales orders

Returns sales orders data that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
orderNo
string (orderNo) <= 10 characters

Filter by order number

customerId
string (customerId) <= 8 characters

Filter by customer

entryDateFrom
string <date-time> (entryDate) = 20 characters

Filter by entry date

entryDateUntil
string <date-time> (entryDate) = 20 characters

Filter by entry date

companyId
string (companyId) <= 12 characters

Filter by company

status
string (status) <= 1 characters

Filter by status

processingStatus
integer (processingStatus)
Enum: 0 1 2 3 10 11

Filter by processing status

  • 0 - Open
  • 1 - Externally completed only
  • 2 - Internally completed only
  • 3 - Completed
  • 10 - Open (Offers only)
  • 11 - Completed (Offers only)
siteNo
integer (siteNo)

Filter by site number

limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

/invoices

Invoice operations

List invoices

Returns invoice data that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

orderNo
string (orderNo) <= 10 characters

Filter by order number

customerId
string (customerId) <= 8 characters

Filter by customer

companyId
string (companyId) <= 12 characters

Filter by company

invoiceDateFrom
string <date-time> (invoiceDate) = 20 characters

Filter by invoice date

invoiceDateUntil
string <date-time> (invoiceDate) = 20 characters

Filter by invoice date

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

/salesPrices

Sales prices operations

List all sales prices

Returns sales prices data that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
articleNo
string (articleNo) <= 15 characters

Filter by article number

priceListName
string (priceListName) <= 12 characters

Filter by key of a price list

status
string (status) <= 1 characters

Filter by status

limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

/stockEntries

Stock entry operations

List stock entries

Returns all stock entries from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
articleNo
string (articleNo) <= 15 characters

Filter by article number

batchNo
string (batchNo) <= 24 characters

Filter by batch number

postingDateFrom
string <date-time> (postingDate) = 20 characters

Filter by posting date

postingDateUntil
string <date-time> (postingDate) = 20 characters

Filter by posting date

siteNo
integer (siteNo)

Filter by site number

storageLocation
string (storageLocation) <= 12 characters

Filter by storage location

stockEntryNo
integer (stockEntryNo)

Filter by stock entry number

stockEntryNoFrom
integer (stockEntryNo)

Filter by stock entry number from

stockEntryNoUntil
integer (stockEntryNo)

Filter by stock entry number until

stampFrom
string <date-time> (stamp) = 20 characters

Filter by timestamp

stampUntil
string <date-time> (stamp) = 20 characters

Filter by timestamp

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

List stock entry by number Deprecated

Returns the desired stock entry.

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
stockEntryNo
required
integer (stockEntryNo)

Unique number of a stock entry

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 1,
  • "data": [
    ]
}

/stockLevel

Stock level operations

List actual stock level

Returns the actual system stock level that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

articleNo
string (articleNo) <= 15 characters

Filter by article number

storageLocation
string (storageLocation) <= 12 characters

Filter by storage location

siteNo
integer (siteNo)

Filter by site number

baseUnit
string (baseUnit) <= 12 characters

Filter by article base unit

packagingUnit
string (packagingUnit) <= 30 characters

Filter by packagingUnit

scope
string
Value: "app"

Filter by scope for a more precise response.

  • app - for internal use only

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

List actual batch stock level

Returns the actual system stock level of batches that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

articleNo
string (articleNo) <= 15 characters

Filter by article number

batchNo
string (batchNo) <= 24 characters

Filter by batch number

storageLocation
string (storageLocation) <= 12 characters

Filter by storage location

siteNo
integer (siteNo)

Filter by site number

baseUnit
string (baseUnit) <= 12 characters

Filter by article base unit

packagingUnit
string (packagingUnit) <= 30 characters

Filter by packagingUnit

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

Perform stock operations

Perform stock posting/booking

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
bookType
required
string
Enum: "input" "output" "relocate" "split" "merge"

Type of posting

query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
Any of
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

quantity
required
number <float> (quantity)

Quantity

packagingUnit
string (packagingUnit) <= 30 characters

The packaging unit

siteNo
required
integer (siteNo)

Site number

storageLocation
required
string (storageLocation) <= 12 characters

Name of the storage location

createPallet
boolean

Flag set to true if you want to generate the next pallet no (input only)

includeSSCC
boolean (includeSSCC)

Indicates if the Serial Shipping Container Code (SSCC) should be included in the message. The variable ShopIF_RESTProzedurSSCC must be configured.

recipeOutput
boolean

Flag set to true if you want to book materials outputs for input value (input only)

batchComment
string (comment) <= 255 characters

Comment

batchComment1
string (comment) <= 255 characters

Comment

batchComment2
string (comment) <= 255 characters

Comment

printLabel
boolean (printLabel)

Flag set to true if you want to print a label (input only)

postingDate
string <date-time> (postingDate) = 20 characters

Posting date

foreignBatchNo
string (foreignBatchNo) <= 24 characters

Foreign batch of the article batch

comment
string (comment) <= 255 characters

Comment

proRata
boolean

Flag set to true if you want to book material outputs pro rata for input value (input only)

Responses

Request samples

Content type
application/json
Example

Relocate stock with batch and without packaging unit

{
  • "articleNo": "P001",
  • "batchNo": "10060",
  • "quantityBaseUnit": 2,
  • "sourceSiteNo": 1,
  • "sourceStorageLocation": "roh",
  • "targetSiteNo": 1,
  • "targetStorageLocation": "prod"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

/stockOrders

Stock order operations

List picking jobs

Returns all picking jobs from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
stockEntryNo
integer (stockEntryNo)

Filter by stock entry number

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Create picking job.

Create picking jobs for orders or rearrangements

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
articleNo
string (articleNo) <= 15 characters

Number of the article

batchNo
string (batchNo) <= 24 characters

Batch of the article

siteNo
integer (siteNo)

Site number

sourceStorageLocation
string (storageLocation) <= 12 characters

Name of the storage location

targetStorageLocation
string (storageLocation) <= 12 characters

Name of the storage location

quantity
number <float> (quantity)

Quantity

packagingUnit
string (packagingUnit) <= 30 characters

The packaging unit

startBy
string (startBy) <= 12 characters

User who started action

pickUp
boolean

Flag set to true if you want to pickup the job

Responses

Request samples

Content type
application/json
{
  • "articleNo": "C001",
  • "batchNo": "10000",
  • "quantity": 560,
  • "siteNo": 1,
  • "sourceStorageLocation": "qua",
  • "targetStorageLocation": "Vers",
  • "pickUp": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Create new picking jobs or update existing ones (batch)

Creates or patches picking jobs and returns their stockEntryNo's.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
Array
Any of
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

siteNo
required
integer (siteNo)

Site number

sourceStorageLocation
required
string (storageLocation) <= 12 characters

Name of the storage location

targetStorageLocation
required
string (storageLocation) <= 12 characters

Name of the storage location

quantity
required
number <float> (quantity)

Quantity

packagingUnit
string (packagingUnit) <= 30 characters

The packaging unit

startBy
string (startBy) <= 12 characters

User who started action

pickUp
boolean

Flag set to true if you want to pickup the job

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Perform actions on picking job

Pick, park, change or complete a job and returns the entry id.

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
stockEntryNo
required
integer (stockEntryNo)

Unique number of a stock entry

query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
targetStorageLocation
string (storageLocation) <= 12 characters

Name of the storage location

quantity
number <float> (quantity)

Quantity

packagingUnit
string (packagingUnit) <= 30 characters

The packaging unit

action
string
Enum: "lock" "unlock"

Action to perform on the picking job

startBy
string (startBy) <= 12 characters

User who started action

pickUp
boolean

Flag set to true if you want to pickup the job

Responses

Request samples

Content type
application/json
Example
{
  • "pickUp": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

/stockReservation

Stock reservation operations

List stock reservations

Get reservations of sales or production orders

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
articleNo
string (articleNo) <= 15 characters

Filter by article number

batchNo
string (batchNo) <= 24 characters

Filter by batch number

storageLocation
string (storageLocation) <= 12 characters

Filter by storage location

siteNo
integer (siteNo)

Filter by site number

orderNo
string (orderNo) <= 10 characters

Filter by order number

orderPosNo
integer (orderPosNo)

Filter by order position number

assignedOnly
boolean

Show reservations with assigned batches only

Responses

Response samples

Content type
applications/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

/dispositionOrders

Disposition order operations

List disposition orders

Returns all current disposition orders from the system that the user has access to. Disposition orders can contain cross-order stock orders.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
dispoNo
number <integer> (dispoNo)

Filter by disposition order number

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

/inventory

Inventory operations

Submit inventory count

Submits a count in the inventory.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
string (batchNo) <= 24 characters

Batch of the article

quantity
required
number <float> (quantity)

Quantity

siteNo
required
integer (siteNo)

Site number

storageLocation
required
string (storageLocation) <= 12 characters

Name of the storage location

packagingUnit
string (packagingUnit) <= 30 characters

The packaging unit

comment
string (comment) <= 255 characters

Comment

Responses

Request samples

Content type
application/json
{
  • "articleNo": "string",
  • "batchNo": "string",
  • "quantity": 0.1,
  • "siteNo": 0,
  • "storageLocation": "string",
  • "packagingUnit": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

/subscriptions

Subscriptions operations

List subscriptions

Returns all subscriptions from the system that the user has access to.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
limit
number <integer> (limit)
Default: 0

Maximum number of results, activates pagination

offset
number <integer> (offset)
Default: 0

Defines the offset of the pagination

subscriptionId
string (subscriptionId) <= 12 characters

Filter by subscription number, [orderNo].[posNo] in casymir

customerId
string (customerId) <= 8 characters

Filter by customer

companyId
string (companyId) <= 12 characters

Filter by company

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "pagination": {
    },
  • "count": 0,
  • "data": [
    ]
}

Create a subscription

Creates a subscription and returns the subscriptionId.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
customerId
required
string (customerId) <= 8 characters

Number of the customer

articleNo
required
string (articleNo) <= 15 characters

Number of the article

startDate
required
string <date-time> (startDate) = 20 characters

Date of the started action

orderNo
string (orderNo) <= 10 characters

Production or sales order number

foreignSubscriptionId
string (foreignSubscriptionId) <= 200 characters

Foreign subscription id, for example from a third party system

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "articleNo": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "orderNo": "string",
  • "foreignSubscriptionId": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

/customMachineSupplies

Machine supplies operations

Customized processing of the replenishment to a machine

Endpoint mapped to customer plugin event processing to organize supllies for production means.

Authorizations:
basicAuthoAuth2ClientCredentials
query Parameters
user
string <= 12 characters

Set the casymir user name for history

Request Body schema: application/json
articleNo
required
string (articleNo) <= 15 characters

Number of the article

batchNo
required
string (batchNo) <= 24 characters

Batch of the article

partArticleNo
required
string (articleNo) <= 15 characters

Number of the article

siteNo
required
integer (siteNo)

Site number

storageLocation
required
string (storageLocation) <= 12 characters

Name of the storage location

Responses

Request samples

Content type
application/json
{
  • "articleNo": "string",
  • "batchNo": "string",
  • "partArticleNo": "string",
  • "siteNo": 0,
  • "storageLocation": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

/archive

Archive documents

Archive documents in a connected DMS (multiple possible). Returns the record id in any connected DMS.

Authorizations:
basicAuthoAuth2ClientCredentials
Request Body schema: application/json
required
Array of objects

List of files to archive

required
object

Report details (see CASYMIR ArchivZuordnungDetail)

object

Additional options

Responses

Request samples

Content type
application/json
{
  • "files": [
    ],
  • "report": {
    },
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 1,
  • "data": [
    ]
}

Search for documents

Search for documents in a connected DMS (multiple possible). Returns the found records in any connected DMS.

Authorizations:
basicAuthoAuth2ClientCredentials
Request Body schema: application/json
required
Array of objects or objects

List of filters to apply to the search

object

Additional options

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 1,
  • "data": [
    ]
}

/edi

List incoming EDI message types

Returns all possible incoming EDI message types.

Authorizations:
basicAuthoAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Process incoming EDI message

Processes an incoming EDI message.

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
messageType
required
string
Value: "DELFOR"

The type of the message (e.g. 'ORDERS')

Request Body schema: application/json
required

Request body for importing an incoming EDI message

Any of
filePath
required
string

The path of the file

format
string

The format of the message. Default: AFx format of the message

Responses

Request samples

Content type
application/json
{
  • "file": "string",
  • "format": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

List outgoing EDI message types

Returns all possible outgoing EDI message types.

Authorizations:
basicAuthoAuth2ClientCredentials

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": [
    ]
}

Create outgoing EDI message

Creates an outgoing EDI message.

Authorizations:
basicAuthoAuth2ClientCredentials
path Parameters
messageType
required
string
Enum: "DESADV" "INVOIC" "ORDRSP"

The type of the message (e.g. 'DESADV')

Request Body schema: application/json
required

Request body for creating an outgoing EDI message

orderNo
required
string (orderNo) <= 10 characters

Production or sales order number

invoiceNo
string (invoiceNo) <= 10 characters

Invoice number

format
string

The format of the message. Default: AFx format of the message

writeFile
boolean

Indicates if the message should be written to a file. Default: true

writeFolder
string

The folder where the file should be written. Default: /tmp

includeFile
boolean

Indicates if the file should be included in the message. Default: false

functionCode
string
Enum: "N" "S"

The function code of the message. Default: N

fileName
string

The name of the file

Responses

Request samples

Content type
application/json
{
  • "orderNo": "string",
  • "invoiceNo": "string",
  • "format": "string",
  • "writeFile": true,
  • "writeFolder": "string",
  • "includeFile": true,
  • "functionCode": "N",
  • "fileName": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "count": 0,
  • "data": {
    }
}