API docs by Redocly

ACMEcrm API (1.0.0)

Download OpenAPI specification:

License: Apache-2.0

Sales system of ACME analog Inc. and system of record for customers & resellers, products, price lists, quotes and orders (production contracts).

Orders are confirmed via the e-approval system: above defined thresholds an authorized signatory must approve (resolved via ACMEhr — approval limits/deputies). Confirmed orders (products, quantities, delivery dates) drive factory, port and treasury.

Roles (ACMEbase): WATCH reads, WORK writes operationally (quotes/orders/approval), ADMIN maintains master data (products/price lists). Per operation under x-required-role; hierarchy ADMIN > WORK > WATCH.

Customers

Customers and resellers (sales partners).

List customers/resellers

Authorizations:
bearerAuth
query Parameters
kind
string (CustomerKind)
Enum: "CUSTOMER" "RESELLER"
status
string (CustomerStatus)
Enum: "PROSPECT" "ACTIVE" "BLOCKED"
resellerId
string

Customers of a reseller.

q
string

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
kind
required
string (CustomerKind)
Enum: "CUSTOMER" "RESELLER"
status
required
string (CustomerStatus)
Enum: "PROSPECT" "ACTIVE" "BLOCKED"
email
string or null <email>
country
string or null
parentResellerId
string or null

For end customers of a reseller.

priceListId
string or null

Assigned price list.

Response samples

Content type
application/json
[
  • {
    • "id": "string",
    • "name": "Kontor Nord GmbH",
    • "kind": "CUSTOMER",
    • "status": "PROSPECT",
    • "email": "user@example.com",
    • "country": "DE",
    • "parentResellerId": "string",
    • "priceListId": "string"
    }
]

Create customer/reseller

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
kind
required
string (CustomerKind)
Enum: "CUSTOMER" "RESELLER"
status
string (CustomerStatus)
Enum: "PROSPECT" "ACTIVE" "BLOCKED"
email
string <email>
country
string
parentResellerId
string or null
priceListId
string or null

Responses

Response Schema: application/json
id
required
string
name
required
string
kind
required
string (CustomerKind)
Enum: "CUSTOMER" "RESELLER"
status
required
string (CustomerStatus)
Enum: "PROSPECT" "ACTIVE" "BLOCKED"
email
string or null <email>
country
string or null
parentResellerId
string or null

For end customers of a reseller.

priceListId
string or null

Assigned price list.

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind": "CUSTOMER",
  • "status": "PROSPECT",
  • "email": "user@example.com",
  • "country": "string",
  • "parentResellerId": "string",
  • "priceListId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "Kontor Nord GmbH",
  • "kind": "CUSTOMER",
  • "status": "PROSPECT",
  • "email": "user@example.com",
  • "country": "DE",
  • "parentResellerId": "string",
  • "priceListId": "string"
}

Read customer

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
name
required
string
kind
required
string (CustomerKind)
Enum: "CUSTOMER" "RESELLER"
status
required
string (CustomerStatus)
Enum: "PROSPECT" "ACTIVE" "BLOCKED"
email
string or null <email>
country
string or null
parentResellerId
string or null

For end customers of a reseller.

priceListId
string or null

Assigned price list.

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "Kontor Nord GmbH",
  • "kind": "CUSTOMER",
  • "status": "PROSPECT",
  • "email": "user@example.com",
  • "country": "DE",
  • "parentResellerId": "string",
  • "priceListId": "string"
}

Update customer

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
required
string
kind
required
string (CustomerKind)
Enum: "CUSTOMER" "RESELLER"
status
string (CustomerStatus)
Enum: "PROSPECT" "ACTIVE" "BLOCKED"
email
string <email>
country
string
parentResellerId
string or null
priceListId
string or null

Responses

Response Schema: application/json
id
required
string
name
required
string
kind
required
string (CustomerKind)
Enum: "CUSTOMER" "RESELLER"
status
required
string (CustomerStatus)
Enum: "PROSPECT" "ACTIVE" "BLOCKED"
email
string or null <email>
country
string or null
parentResellerId
string or null

For end customers of a reseller.

priceListId
string or null

Assigned price list.

Request samples

Content type
application/json
{
  • "name": "string",
  • "kind": "CUSTOMER",
  • "status": "PROSPECT",
  • "email": "user@example.com",
  • "country": "string",
  • "parentResellerId": "string",
  • "priceListId": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "Kontor Nord GmbH",
  • "kind": "CUSTOMER",
  • "status": "PROSPECT",
  • "email": "user@example.com",
  • "country": "DE",
  • "parentResellerId": "string",
  • "priceListId": "string"
}

Products

Product catalog (analog goods from the ACME factory).

List products

Authorizations:
bearerAuth
query Parameters
category
string
active
boolean
q
string

Responses

Response Schema: application/json
Array
id
required
string
sku
required
string
name
required
string
category
string or null
unit
string
Default: "piece"
active
required
boolean
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

Response samples

Content type
application/json
[
  • {
    • "id": "string",
    • "sku": "ACME-RADIO-01",
    • "name": "Tube radio „Nostalgie“",
    • "category": "string",
    • "unit": "piece",
    • "active": true,
    • "listPrice": {
      }
    }
]

Create product (master data)

Authorizations:
bearerAuth
Request Body schema: application/json
required
sku
required
string
name
required
string
category
string
unit
string
active
boolean
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

Responses

Response Schema: application/json
id
required
string
sku
required
string
name
required
string
category
string or null
unit
string
Default: "piece"
active
required
boolean
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

Request samples

Content type
application/json
{
  • "sku": "string",
  • "name": "string",
  • "category": "string",
  • "unit": "string",
  • "active": true,
  • "listPrice": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "sku": "ACME-RADIO-01",
  • "name": "Tube radio „Nostalgie“",
  • "category": "string",
  • "unit": "piece",
  • "active": true,
  • "listPrice": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    }
}

Read product

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
sku
required
string
name
required
string
category
string or null
unit
string
Default: "piece"
active
required
boolean
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

Response samples

Content type
application/json
{
  • "id": "string",
  • "sku": "ACME-RADIO-01",
  • "name": "Tube radio „Nostalgie“",
  • "category": "string",
  • "unit": "piece",
  • "active": true,
  • "listPrice": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    }
}

Update product (master data)

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
sku
required
string
name
required
string
category
string
unit
string
active
boolean
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

Responses

Response Schema: application/json
id
required
string
sku
required
string
name
required
string
category
string or null
unit
string
Default: "piece"
active
required
boolean
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

Request samples

Content type
application/json
{
  • "sku": "string",
  • "name": "string",
  • "category": "string",
  • "unit": "string",
  • "active": true,
  • "listPrice": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "sku": "ACME-RADIO-01",
  • "name": "Tube radio „Nostalgie“",
  • "category": "string",
  • "unit": "piece",
  • "active": true,
  • "listPrice": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    }
}

PriceLists

Price lists (list/reseller) with tiered prices + price resolution.

List price lists

Authorizations:
bearerAuth
query Parameters
kind
string (PriceListKind)
Enum: "LIST" "RESELLER" "CUSTOM"

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
currency
required
string = 3 characters
kind
required
string (PriceListKind)
Enum: "LIST" "RESELLER" "CUSTOM"
object (DateRange)

Validity period. until=null = open-ended.

required
Array of objects (PriceListItem)

Response samples

Content type
application/json
[
  • {
    • "id": "string",
    • "name": "string",
    • "currency": "EUR",
    • "kind": "LIST",
    • "validity": {
      },
    • "items": [
      ]
    }
]

Create price list (master data)

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
currency
required
string = 3 characters
kind
required
string (PriceListKind)
Enum: "LIST" "RESELLER" "CUSTOM"
validFrom
string <date>
validUntil
string or null <date>
Array of objects (PriceListItem)

Responses

Response Schema: application/json
id
required
string
name
required
string
currency
required
string = 3 characters
kind
required
string (PriceListKind)
Enum: "LIST" "RESELLER" "CUSTOM"
object (DateRange)

Validity period. until=null = open-ended.

required
Array of objects (PriceListItem)

Request samples

Content type
application/json
{
  • "name": "string",
  • "currency": "str",
  • "kind": "LIST",
  • "validFrom": "2019-08-24",
  • "validUntil": "2019-08-24",
  • "items": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "currency": "EUR",
  • "kind": "LIST",
  • "validity": {
    • "from": "2019-08-24",
    • "until": "2019-08-24"
    },
  • "items": [
    • {
      }
    ]
}

Read price list

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
name
required
string
currency
required
string = 3 characters
kind
required
string (PriceListKind)
Enum: "LIST" "RESELLER" "CUSTOM"
object (DateRange)

Validity period. until=null = open-ended.

required
Array of objects (PriceListItem)

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "currency": "EUR",
  • "kind": "LIST",
  • "validity": {
    • "from": "2019-08-24",
    • "until": "2019-08-24"
    },
  • "items": [
    • {
      }
    ]
}

Resolve effective unit price

Returns the unit price applicable for customer + product + quantity (incl. tier/reseller).

Authorizations:
bearerAuth
query Parameters
customerId
required
string
productId
required
string
quantity
integer >= 1
Default: 1

Responses

Response Schema: application/json
productId
required
string
customerId
required
string
quantity
required
integer
unitPrice
required
number
currency
string
priceListId
string or null
source
string
Enum: "PRICE_LIST" "LIST_PRICE"

Response samples

Content type
application/json
{
  • "productId": "string",
  • "customerId": "string",
  • "quantity": 0,
  • "unitPrice": 0,
  • "currency": "string",
  • "priceListId": "string",
  • "source": "PRICE_LIST"
}

Quotes

Quotes — draft through acceptance, conversion into an order.

List quotes

Authorizations:
bearerAuth
query Parameters
customerId
string
status
string (QuoteStatus)
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED" "EXPIRED"

Responses

Response Schema: application/json
Array
id
required
string
customerId
required
string
customerName
string
status
required
string (QuoteStatus)
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED" "EXPIRED"
currency
required
string
validUntil
string or null <date>
required
Array of objects (Line)
netTotal
required
number
createdOn
string or null <date>

Response samples

Content type
application/json
[
  • {
    • "id": "string",
    • "customerId": "string",
    • "customerName": "string",
    • "status": "DRAFT",
    • "currency": "string",
    • "validUntil": "2019-08-24",
    • "lines": [
      ],
    • "netTotal": 0,
    • "createdOn": "2019-08-24"
    }
]

Create quote

Unit prices are resolved from the customer's price list if not provided.

Authorizations:
bearerAuth
Request Body schema: application/json
required
customerId
required
string
validUntil
string or null <date>
required
Array of objects (LineWrite) non-empty

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
status
required
string (QuoteStatus)
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED" "EXPIRED"
currency
required
string
validUntil
string or null <date>
required
Array of objects (Line)
netTotal
required
number
createdOn
string or null <date>

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "validUntil": "2019-08-24",
  • "lines": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "status": "DRAFT",
  • "currency": "string",
  • "validUntil": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "netTotal": 0,
  • "createdOn": "2019-08-24"
}

Read quote

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
status
required
string (QuoteStatus)
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED" "EXPIRED"
currency
required
string
validUntil
string or null <date>
required
Array of objects (Line)
netTotal
required
number
createdOn
string or null <date>

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "status": "DRAFT",
  • "currency": "string",
  • "validUntil": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "netTotal": 0,
  • "createdOn": "2019-08-24"
}

Update quote (status/validity)

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
status
string (QuoteStatus)
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED" "EXPIRED"
validUntil
string or null <date>

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
status
required
string (QuoteStatus)
Enum: "DRAFT" "SENT" "ACCEPTED" "REJECTED" "EXPIRED"
currency
required
string
validUntil
string or null <date>
required
Array of objects (Line)
netTotal
required
number
createdOn
string or null <date>

Request samples

Content type
application/json
{
  • "status": "DRAFT",
  • "validUntil": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "status": "DRAFT",
  • "currency": "string",
  • "validUntil": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "netTotal": 0,
  • "createdOn": "2019-08-24"
}

Convert quote into order

Marks the quote as accepted and creates an order from it.

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}

Orders

Orders incl. e-approval (submission, approval/rejection, production, fulfillment).

List orders

Consumers read the approved orders via status=APPROVED for the production cycle.

Authorizations:
bearerAuth
query Parameters
customerId
string
status
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"

Responses

Response Schema: application/json
Array
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Response samples

Content type
application/json
[
  • {
    • "id": "string",
    • "customerId": "string",
    • "customerName": "string",
    • "customerCountry": "string",
    • "quoteId": "string",
    • "status": "CREATED",
    • "orderDate": "2019-08-24",
    • "lines": [
      ],
    • "total": {
      },
    • "approval": {
      },
    • "shippingMode": "string",
    • "note": "string"
    }
]

Create order

Authorizations:
bearerAuth
Request Body schema: application/json
required
customerId
required
string
quoteId
string or null
required
Array of objects (LineWrite) non-empty
shippingMode
string or null
note
string or null

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "quoteId": "string",
  • "lines": [
    • {
      }
    ],
  • "shippingMode": "string",
  • "note": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}

Delete all orders (data reset)

Destructive reset of the order stock — intended only for the data/economy reset, hence ADMIN. Not for normal operation.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/problem+json
{
  • "type": "http://example.com",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Read order

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}

Submit order for approval (e-approval)

Sets the status to PENDING_APPROVAL or — below the threshold — directly to APPROVED.

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}

Approval decision (e-approval)

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
approverId
required
string

Person (ACMEhr) making the decision.

decision
required
string
Enum: "APPROVE" "REJECT"
comment
string or null

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Request samples

Content type
application/json
{
  • "approverId": "string",
  • "decision": "APPROVE",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}

Record produced quantities (partial fulfillment)

Reports the quantities produced on a day per line; reduces remainingQuantity. The production cycle calls this after manufacturing. Once the order is thereby complete, it moves to FULFILLED.

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
required
Array of objects non-empty

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}

Mark order as fully fulfilled

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}

Cancel order

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response Schema: application/json
id
required
string
customerId
required
string
customerName
string
customerCountry
string or null
quoteId
string or null
status
required
string (OrderStatus)
Enum: "CREATED" "PENDING_APPROVAL" "APPROVED" "REJECTED" "FULFILLED" "CANCELLED"
orderDate
required
string <date>
required
Array of objects (Line)
required
object (Money)

Monetary amount. unlimited=true → no amount limit (then amount/currency are empty).

object (Approval)

E-approval status of an order/procurement.

shippingMode
string or null

Shipping mode (e.g. AIR = air freight, otherwise sea freight).

note
string or null

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "customerName": "string",
  • "customerCountry": "string",
  • "quoteId": "string",
  • "status": "CREATED",
  • "orderDate": "2019-08-24",
  • "lines": [
    • {
      }
    ],
  • "total": {
    • "amount": 50000,
    • "currency": "EUR",
    • "unlimited": false
    },
  • "approval": {
    • "required": true,
    • "approverId": "string",
    • "decision": "APPROVE",
    • "decidedOn": "2019-08-24",
    • "comment": "string"
    },
  • "shippingMode": "string",
  • "note": "string"
}