WSE · Schnittstellen

Produktpakete

Verbinden Sie WSE mit Ihren Anwendungen. Entdecken Sie Endpunkte, Datenmodelle und Schnittstellen – nach Funktionsbereichen und Add-ons geordnet.

OpenAPI herunterladen ↓
REST · JSONBearer-Authentifizierung
API docs by Redocly

Produktpakete

ERP API Dokumentation

Produktpakete

Add-on erforderlich: Produktpakete. Die Nutzung setzt das freigeschaltete Add-on und passende Benutzerberechtigungen voraus.

List Product Bundles Endpoint

Return paginated product bundles.

Authorizations:
BearerAuth
query Parameters
Is Active (boolean) or Is Active (null) (Is Active)
Available On (string) or Available On (null) (Available On)
skip
integer (Skip) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 1000 ]
Default: 100

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/product-bundles?is_active=true&available_on=2019-08-24&skip=0&limit=100' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "total_count": 0,
  • "items": [
    ]
}

Create Product Bundle Endpoint

Create one product bundle.

Authorizations:
BearerAuth
Request Body schema: application/json
required
bundle_key
required
string (Bundle Key) [ 1 .. 120 ] characters ^[a-z0-9]+([._-][a-z0-9]+)*$

Lowercase stable slug key.

name
required
string (Name) [ 1 .. 200 ] characters
Description (string) or Description (null) (Description)
Any of
<= 20000 characters
string <text/markdown> (Description) <= 20000 characters

CommonMark source for the product bundle. Raw HTML and images are not allowed. Links must use HTTPS, a root-relative path, an anchor, mailto, or tel.

is_active
boolean (Is Active)
Default: true
sort_order
integer (Sort Order) >= 0
Default: 0
Available From (string) or Available From (null) (Available From)
Any of
string <date> (Available From)
Available Until (string) or Available Until (null) (Available Until)
Any of
string <date> (Available Until)

Responses

Request samples

Content type
application/json
{
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Get Product Bundle Endpoint

Return one product bundle.

Authorizations:
BearerAuth
path Parameters
product_bundle_id
required
string <uuid4> (Product Bundle Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request GET \
  --url 'https://your-instance.example.invalid/product-bundles/string' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Update Product Bundle Endpoint

Update one product bundle.

Authorizations:
BearerAuth
path Parameters
product_bundle_id
required
string <uuid4> (Product Bundle Id)
Request Body schema: application/json
required
Bundle Key (string) or Bundle Key (null) (Bundle Key)
Any of
[ 1 .. 120 ] characters
string (Bundle Key) [ 1 .. 120 ] characters ^[a-z0-9]+([._-][a-z0-9]+)*$

Lowercase stable slug key.

Name (string) or Name (null) (Name)
Any of
[ 1 .. 200 ] characters
string (Name) [ 1 .. 200 ] characters
Description (string) or Description (null) (Description)
Any of
<= 20000 characters
string <text/markdown> (Description) <= 20000 characters

CommonMark source for the product bundle. Raw HTML and images are not allowed. Links must use HTTPS, a root-relative path, an anchor, mailto, or tel.

Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
Sort Order (integer) or Sort Order (null) (Sort Order)
Any of
>= 0
integer (Sort Order) >= 0
Available From (string) or Available From (null) (Available From)
Any of
string <date> (Available From)
Available Until (string) or Available Until (null) (Available Until)
Any of
string <date> (Available Until)

Responses

Request samples

Content type
application/json
{
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Delete Product Bundle Endpoint

Delete one product bundle.

Authorizations:
BearerAuth
path Parameters
product_bundle_id
required
string <uuid4> (Product Bundle Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/product-bundles/string' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Create Product Bundle Group Endpoint

Create one product bundle group.

Authorizations:
BearerAuth
path Parameters
product_bundle_id
required
string <uuid4> (Product Bundle Id)
Request Body schema: application/json
required
group_key
required
string (Group Key) [ 1 .. 120 ] characters ^[a-z0-9]+([._-][a-z0-9]+)*$

Lowercase stable slug key.

name
required
string (Name) [ 1 .. 200 ] characters
Description (string) or Description (null) (Description)
Any of
<= 20000 characters
string <text/markdown> (Description) <= 20000 characters

CommonMark source for the product bundle group. Raw HTML and images are not allowed. Links must use HTTPS, a root-relative path, an anchor, mailto, or tel.

is_active
boolean (Is Active)
Default: true
is_required
boolean (Is Required)
Default: false
selection_mode
string (ProductBundleSelectionMode)
Default: "multiple"
Enum: "single" "multiple"

Supported selection modes for one product bundle group.

min_selected_products
integer (Min Selected Products) >= 0
Default: 0
Max Selected Products (integer) or Max Selected Products (null) (Max Selected Products)
Any of
>= 0
integer (Max Selected Products) >= 0
Min Total Quantity (number) or Min Total Quantity (string) (Min Total Quantity)
Default: "0.00"
Any of
>= 0
number (Min Total Quantity) >= 0
Default: "0.00"
Max Total Quantity (number) or Max Total Quantity (string) or Max Total Quantity (null) (Max Total Quantity)
Any of
>= 0
number (Max Total Quantity) >= 0
sort_order
integer (Sort Order) >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "group_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "is_required": false,
  • "selection_mode": "single",
  • "min_selected_products": 0,
  • "max_selected_products": 0,
  • "min_total_quantity": "0.00",
  • "max_total_quantity": 0,
  • "sort_order": 0
}

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Update Product Bundle Group Endpoint

Update one product bundle group.

Authorizations:
BearerAuth
path Parameters
product_bundle_group_id
required
string <uuid4> (Product Bundle Group Id)
Request Body schema: application/json
required
Group Key (string) or Group Key (null) (Group Key)
Any of
[ 1 .. 120 ] characters
string (Group Key) [ 1 .. 120 ] characters ^[a-z0-9]+([._-][a-z0-9]+)*$

Lowercase stable slug key.

Name (string) or Name (null) (Name)
Any of
[ 1 .. 200 ] characters
string (Name) [ 1 .. 200 ] characters
Description (string) or Description (null) (Description)
Any of
<= 20000 characters
string <text/markdown> (Description) <= 20000 characters

CommonMark source for the product bundle group. Raw HTML and images are not allowed. Links must use HTTPS, a root-relative path, an anchor, mailto, or tel.

Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
Is Required (boolean) or Is Required (null) (Is Required)
Any of
boolean (Is Required)
ProductBundleSelectionMode (string) or null
Any of
string (ProductBundleSelectionMode)
Enum: "single" "multiple"

Supported selection modes for one product bundle group.

Min Selected Products (integer) or Min Selected Products (null) (Min Selected Products)
Any of
>= 0
integer (Min Selected Products) >= 0
Max Selected Products (integer) or Max Selected Products (null) (Max Selected Products)
Any of
>= 0
integer (Max Selected Products) >= 0
Min Total Quantity (number) or Min Total Quantity (string) or Min Total Quantity (null) (Min Total Quantity)
Any of
>= 0
number (Min Total Quantity) >= 0
Max Total Quantity (number) or Max Total Quantity (string) or Max Total Quantity (null) (Max Total Quantity)
Any of
>= 0
number (Max Total Quantity) >= 0
Sort Order (integer) or Sort Order (null) (Sort Order)
Any of
>= 0
integer (Sort Order) >= 0

Responses

Request samples

Content type
application/json
{
  • "group_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "is_required": true,
  • "selection_mode": "single",
  • "min_selected_products": 0,
  • "max_selected_products": 0,
  • "min_total_quantity": 0,
  • "max_total_quantity": 0,
  • "sort_order": 0
}

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Delete Product Bundle Group Endpoint

Delete one product bundle group.

Authorizations:
BearerAuth
path Parameters
product_bundle_group_id
required
string <uuid4> (Product Bundle Group Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/product-bundle-groups/string' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Create Product Bundle Group Product Endpoint

Add one product option to a product bundle group.

Authorizations:
BearerAuth
path Parameters
product_bundle_group_id
required
string <uuid4> (Product Bundle Group Id)
Request Body schema: application/json
required
product_id
required
string <uuid4> (Product Id)
Display Name Override (string) or Display Name Override (null) (Display Name Override)
Any of
<= 200 characters
string (Display Name Override) <= 200 characters
Description Override (string) or Description Override (null) (Description Override)
Any of
<= 10000 characters
string <text/markdown> (Description Override) <= 10000 characters

CommonMark source overriding the product description in this bundle group. Raw HTML and images are not allowed. Links must use HTTPS, a root-relative path, an anchor, mailto, or tel.

is_active
boolean (Is Active)
Default: true
is_default
boolean (Is Default)
Default: false
Min Quantity (number) or Min Quantity (string) (Min Quantity)
Default: "0.00"
Any of
>= 0
number (Min Quantity) >= 0
Default: "0.00"
Max Quantity (number) or Max Quantity (string) or Max Quantity (null) (Max Quantity)
Any of
>= 0
number (Max Quantity) >= 0
Default Quantity (number) or Default Quantity (string) (Default Quantity)
Default: "0.00"
Any of
>= 0
number (Default Quantity) >= 0
Default: "0.00"
Quantity Step (number) or Quantity Step (string) (Quantity Step)
Default: "1.00"
Any of
> 0
number (Quantity Step) > 0
Default: "1.00"
sort_order
integer (Sort Order) >= 0
Default: 0

Responses

Request samples

Content type
application/json
{
  • "product_id": "string",
  • "display_name_override": "string",
  • "description_override": "string",
  • "is_active": true,
  • "is_default": false,
  • "min_quantity": "0.00",
  • "max_quantity": 0,
  • "default_quantity": "0.00",
  • "quantity_step": "1.00",
  • "sort_order": 0
}

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Update Product Bundle Group Product Endpoint

Update one product option in a product bundle group.

Authorizations:
BearerAuth
path Parameters
product_bundle_group_product_id
required
string <uuid4> (Product Bundle Group Product Id)
Request Body schema: application/json
required
Display Name Override (string) or Display Name Override (null) (Display Name Override)
Any of
<= 200 characters
string (Display Name Override) <= 200 characters
Description Override (string) or Description Override (null) (Description Override)
Any of
<= 10000 characters
string <text/markdown> (Description Override) <= 10000 characters

CommonMark source overriding the product description in this bundle group. Raw HTML and images are not allowed. Links must use HTTPS, a root-relative path, an anchor, mailto, or tel.

Is Active (boolean) or Is Active (null) (Is Active)
Any of
boolean (Is Active)
Is Default (boolean) or Is Default (null) (Is Default)
Any of
boolean (Is Default)
Min Quantity (number) or Min Quantity (string) or Min Quantity (null) (Min Quantity)
Any of
>= 0
number (Min Quantity) >= 0
Max Quantity (number) or Max Quantity (string) or Max Quantity (null) (Max Quantity)
Any of
>= 0
number (Max Quantity) >= 0
Default Quantity (number) or Default Quantity (string) or Default Quantity (null) (Default Quantity)
Any of
>= 0
number (Default Quantity) >= 0
Quantity Step (number) or Quantity Step (string) or Quantity Step (null) (Quantity Step)
Any of
> 0
number (Quantity Step) > 0
Sort Order (integer) or Sort Order (null) (Sort Order)
Any of
>= 0
integer (Sort Order) >= 0

Responses

Request samples

Content type
application/json
{
  • "display_name_override": "string",
  • "description_override": "string",
  • "is_active": true,
  • "is_default": true,
  • "min_quantity": 0,
  • "max_quantity": 0,
  • "default_quantity": 0,
  • "quantity_step": 1,
  • "sort_order": 0
}

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Delete Product Bundle Group Product Endpoint

Delete one product option from a product bundle group.

Authorizations:
BearerAuth
path Parameters
product_bundle_group_product_id
required
string <uuid4> (Product Bundle Group Product Id)

Responses

Request samples 

# Example only: replace the instance URL, token and sample values before use.
curl --request DELETE \
  --url 'https://your-instance.example.invalid/product-bundle-group-products/string' \
  --header 'Accept: application/problem+json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Response samples

Content type
application/problem+json
{
  • "type": "urn:wse:problem:bad-request",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "parameters": null,
  • "errors": null
}

Update Product Bundle Group Default Selection Endpoint

Replace the complete default selection of one product bundle group.

Authorizations:
BearerAuth
path Parameters
product_bundle_group_id
required
string <uuid4> (Product Bundle Group Id)
Request Body schema: application/json
required
required
Array of objects (Selections)
Array
product_bundle_group_product_id
required
string <uuid4> (Product Bundle Group Product Id)
required
Quantity (number) or Quantity (string) (Quantity)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "product_bundle_id": "string",
  • "bundle_key": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "sort_order": 0,
  • "available_from": "2019-08-24",
  • "available_until": "2019-08-24",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "groups": [
    ]
}

Validate Product Bundle Selection Endpoint

Validate one product bundle selection.

Authorizations:
BearerAuth
path Parameters
product_bundle_id
required
string <uuid4> (Product Bundle Id)
Request Body schema: application/json
required
Available On (string) or Available On (null) (Available On)
Any of
string <date> (Available On)
Array of objects (Selections)
Array
product_bundle_group_product_id
required
string <uuid4> (Product Bundle Group Product Id)
required
Quantity (number) or Quantity (string) (Quantity)

Responses

Request samples

Content type
application/json
{
  • "available_on": "2019-08-24",
  • "selections": [
    ]
}

Response samples

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