Storefront-API API documentation

/api/_CheckService

/api/_CheckService

/api/user

/api/user /create

/api/user /login

/api/user /logout

/api/user /password/reset

/api/user /password/change

/api/user /password/setup

/api/user /activate

/api/user /delete

/api/customers

/api/customers

/api/customers /switch

/api/customers /me

/api/cart/create

/api/cart/create

/api/cart/create /delete

/api/cart/create /pull

/api/cart/create /item/update

/api/cart/create /item/delete

/api/cart/create /totals

/api/cart/create /save

/api/cart/create /update

/api/cart/create /me

/api/cart/create /switch/{cartId}

/api/cart/create/payment /set/{code}

/api/cart/create/payment/set/{code}

Allows to set code payment method code.

Request
Response

URI Parameters
- code: string (required)

Query Parameters
- token: string (required)
  Customer Scoped JWT Token
- cartId: string (required)
  Cart UUID

Body

Media type: application/json

Type: object

Properties

shippingAddressId: string (required)
paymentAddressId: string (required)
paymentCode: string (required)
shipmentCode: string

Example

{
  "shippingAddressId": "827619ae-d4dd-4ef6-a3ab-de7cfefef23e",
  "paymentAddressId": "2163b285-14d6-4a96-be3a-cf7c93b80dee",
  "paymentCode": "null",
  "shipmentCode": "null"
}

/api/cart/create/payment /address/{addressId}

/api/cart/create/payment/address/{addressId}

Sets payment address

Request
Response

URI Parameters
- addressId: string (required)

Query Parameters
- token: string (required)
  Customer Scoped JWT Token
- cartId: string (required)
  Cart UUID

Body

Media type: application/json

Type: object

Properties

shippingAddressId: string (required)
paymentAddressId: string (required)
paymentCode: string (required)
shipmentCode: string

Example

{
  "shippingAddressId": "827619ae-d4dd-4ef6-a3ab-de7cfefef23e",
  "paymentAddressId": "2163b285-14d6-4a96-be3a-cf7c93b80dee",
  "paymentCode": "null",
  "shipmentCode": "null"
}

/api/cart/create/shipping /set/{code}

/api/cart/create/shipping/set/{code}

Allows to set code shipping method code.

Request
Response

URI Parameters
- code: string (required)

Query Parameters
- token: string (required)
  Customer Scoped JWT Token
- cartId: string (required)
  Cart UUID

Body

Media type: application/json

Type: object

Properties

shippingAddressId: string (required)
paymentAddressId: string (required)
paymentCode: string (required)
shipmentCode: string

Example

{
  "shippingAddressId": "827619ae-d4dd-4ef6-a3ab-de7cfefef23e",
  "paymentAddressId": "2163b285-14d6-4a96-be3a-cf7c93b80dee",
  "paymentCode": "null",
  "shipmentCode": "null"
}

/api/cart/create/shipping /address/{addressId}

/api/cart/create/shipping/address/{addressId}

Sets shipping address

Request
Response

URI Parameters
- addressId: string (required)

Query Parameters
- token: string (required)
  Customer Scoped JWT Token
- cartId: string (required)
  Cart UUID

Body

Media type: application/json

Type: object

Properties

shippingAddressId: string (required)
paymentAddressId: string (required)
paymentCode: string (required)
shipmentCode: string

Example

{
  "shippingAddressId": "827619ae-d4dd-4ef6-a3ab-de7cfefef23e",
  "paymentAddressId": "2163b285-14d6-4a96-be3a-cf7c93b80dee",
  "paymentCode": "null",
  "shipmentCode": "null"
}

/api/order

/api/order

/api/order /history

/api/order/history

Request
Response

Query Parameters
- token: string (required)
  Customer Scoped JWT Token

Body
Media type: application/json
Type: object
Properties
- items: (array of OrderHistoryEntry) (required)
  Items: OrderHistoryEntry
  - order_number: string (required)
  - base_currency_code: string (required)
  - base_grand_total: number (required)
  - base_shipping_amount: number (required)
  - base_shipping_discount_amount: number (required)
  - base_shipping_incl_tax: number (required)
  - base_shipping_tax_amount: number (required)
  - base_subtotal: number (required)
  - base_subtotal_incl_tax: number (required)
  - base_tax_amount: number (required)
  - base_total_due: number (required)
  - discount_tax_compensation_amount: number (required)
  - created_at: datetime (required)
  - customer_email: string (required)
  - entity_id: string (required)
  - global_currency_code: string (required)
  - grand_total: number (required)
  - order_currency_code: string (required)
  - shipping_amount: number (required)
  - shipping_description: string (required)
  - shipping_incl_tax: number (required)
  - shipping_tax_amount: number (required)
  - state: string (required)
  - status: string (required)
  - store_currency_code: string (required)
  - store_name: string (required)
  - subtotal: number (required)
  - subtotal_incl_tax: number (required)
  - tax_amount: number (required)
  - total_due: number (required)
  - total_item_count: number (required)
  - total_qty_ordered: number (required)
  - updated_at: string (required)
  - increment_id: string (required)
  - weight: number (required)
  - items: (array of OrderHistoryProduct) (required)
    Items: OrderHistoryProduct
    base_original_price: number (required)
    qty_ordered: number (required)
    qty_sent: number (required)
    base_price: number (required)
    base_price_incl_tax: number (required)
    base_row_total: number (required)
    base_row_total_incl_tax: number (required)
    base_tax_amount: number (required)
    item_id: string (required)
    name: string (required)
    order_id: string (required)
    original_price: number (required)
    price: number (required)
    price_incl_tax: number (required)
    product_id: string (required)
    product_type: string (required)
    row_total: number (required)
    row_total_incl_tax: number (required)
    sku: string (required)
    store_id: number (required)
    tax_amount: number (required)
    tax_percent: number (required)
    updated_at: string (required)
    is_clickable: boolean (required)
    unit_translations: object (required)
    Example
    { "ENG": "Unit", "DEU": "Einheit" }
    url_path: string (required)
    image: string (required)
  - documents: (array of OrderHistoryDocument) (required)
    Items: OrderHistoryDocument
    document_id: string (required)
    document_type: (one of invoice, shipping-document, unknown) (required)
    document_origin: (one of ERP, Local) (required)
  - payment: object (required)
    - additional_information: (array of ) (required)
    - amount_ordered: number (required)
    - base_amount_ordered: number (required)
    - base_shipping_amount: number (required)
    - entity_id: string (required)
    - method: string (required)
    - parent_id: string (required)
    - shipping_amount: number (required)
    - continuePaymentUrl: string (required)
    - history: (array of PaymentHistory) (required)
      Items: PaymentHistory
      createdAt: datetime (required)
      status: string (required)
      id: string (required)
      methodType: (one of paypal, cashOnDelivery, mollie) (required)
  - shipping_address: object (required)
    - id: string
    - type: (one of STANDARD, SHIPPING, BILLING, ORDER) (required)
      Specifies what type of address to create
    - street: string (required)
    - postCode: string (required)
    - city: string (required)
    - firstName: string (required)
    - lastName: string
    - email: string
    - landId: string
    - telephone: string
    - isActive: boolean
    - isCompany: boolean
    - vatNumber: string
  - billing_address: object (required)
    - id: string
    - type: (one of STANDARD, SHIPPING, BILLING, ORDER) (required)
      Specifies what type of address to create
    - street: string (required)
    - postCode: string (required)
    - city: string (required)
    - firstName: string (required)
    - lastName: string
    - email: string
    - landId: string
    - telephone: string
    - isActive: boolean
    - isCompany: boolean
    - vatNumber: string
    - vat_id: string

/api/order /{orderId}

/api/order/{orderId}

Request
Response

URI Parameters
- orderId: string (required)

Query Parameters
- token: string (required)
  Customer Scoped JWT Token

Body
Media type: application/json
Type: object
Properties
- order_number: string (required)
- base_currency_code: string (required)
- base_grand_total: number (required)
- base_shipping_amount: number (required)
- base_shipping_discount_amount: number (required)
- base_shipping_incl_tax: number (required)
- base_shipping_tax_amount: number (required)
- base_subtotal: number (required)
- base_subtotal_incl_tax: number (required)
- base_tax_amount: number (required)
- base_total_due: number (required)
- discount_tax_compensation_amount: number (required)
- created_at: datetime (required)
- customer_email: string (required)
- entity_id: string (required)
- global_currency_code: string (required)
- grand_total: number (required)
- order_currency_code: string (required)
- shipping_amount: number (required)
- shipping_description: string (required)
- shipping_incl_tax: number (required)
- shipping_tax_amount: number (required)
- state: string (required)
- status: string (required)
- store_currency_code: string (required)
- store_name: string (required)
- subtotal: number (required)
- subtotal_incl_tax: number (required)
- tax_amount: number (required)
- total_due: number (required)
- total_item_count: number (required)
- total_qty_ordered: number (required)
- updated_at: string (required)
- increment_id: string (required)
- weight: number (required)
- items: (array of OrderHistoryProduct) (required)
  Items: OrderHistoryProduct
  - base_original_price: number (required)
  - qty_ordered: number (required)
  - qty_sent: number (required)
  - base_price: number (required)
  - base_price_incl_tax: number (required)
  - base_row_total: number (required)
  - base_row_total_incl_tax: number (required)
  - base_tax_amount: number (required)
  - item_id: string (required)
  - name: string (required)
  - order_id: string (required)
  - original_price: number (required)
  - price: number (required)
  - price_incl_tax: number (required)
  - product_id: string (required)
  - product_type: string (required)
  - row_total: number (required)
  - row_total_incl_tax: number (required)
  - sku: string (required)
  - store_id: number (required)
  - tax_amount: number (required)
  - tax_percent: number (required)
  - updated_at: string (required)
  - is_clickable: boolean (required)
  - unit_translations: object (required)
    Example
    { "ENG": "Unit", "DEU": "Einheit" }
  - url_path: string (required)
  - image: string (required)
- documents: (array of OrderHistoryDocument) (required)
  Items: OrderHistoryDocument
  - document_id: string (required)
  - document_type: (one of invoice, shipping-document, unknown) (required)
  - document_origin: (one of ERP, Local) (required)
- payment: object (required)
  - additional_information: (array of ) (required)
  - amount_ordered: number (required)
  - base_amount_ordered: number (required)
  - base_shipping_amount: number (required)
  - entity_id: string (required)
  - method: string (required)
  - parent_id: string (required)
  - shipping_amount: number (required)
  - continuePaymentUrl: string (required)
  - history: (array of PaymentHistory) (required)
    Items: PaymentHistory
    - createdAt: datetime (required)
    - status: string (required)
    - id: string (required)
    - methodType: (one of paypal, cashOnDelivery, mollie) (required)
- shipping_address: object (required)
  - id: string
  - type: (one of STANDARD, SHIPPING, BILLING, ORDER) (required)
    Specifies what type of address to create
  - street: string (required)
  - postCode: string (required)
  - city: string (required)
  - firstName: string (required)
  - lastName: string
  - email: string
  - landId: string
  - telephone: string
  - isActive: boolean
  - isCompany: boolean
  - vatNumber: string
- billing_address: object (required)
  - id: string
  - type: (one of STANDARD, SHIPPING, BILLING, ORDER) (required)
    Specifies what type of address to create
  - street: string (required)
  - postCode: string (required)
  - city: string (required)
  - firstName: string (required)
  - lastName: string
  - email: string
  - landId: string
  - telephone: string
  - isActive: boolean
  - isCompany: boolean
  - vatNumber: string
  - vat_id: string

/api/order /{integrationName}/{documentId}

/api/payment

/api/payment /methods

/api/payment/methods

Request
Response

Query Parameters
- token: string (required)
  Customer Scoped JWT Token
- cartId: string (required)
  Cart UUID

Body
Media type: application/json
Type: array of PaymentMethod
Items: PaymentMethod
- name: string (required)
- code: string (required)
- title: string (required)
- description: string (required)
- unit_translations: object
  Example
  { "ENG": "Paypal Payment", "DEU": "Zahlung über Paypal" }

/api/payment /{paymentMethod}/pay

/api/payment /receive

/api/payment/receive

This route is used to confirm a payment. This route must be called in order to finish payment process.

Request
Response

Query Parameters
- token: string (required)
  Customer Scoped JWT Token
- orderId: string (required)
  Payment UUID

Body
Media type: application/json
Type: object
Properties
- order_number: string (required)
- base_currency_code: string (required)
- base_grand_total: number (required)
- base_shipping_amount: number (required)
- base_shipping_discount_amount: number (required)
- base_shipping_incl_tax: number (required)
- base_shipping_tax_amount: number (required)
- base_subtotal: number (required)
- base_subtotal_incl_tax: number (required)
- base_tax_amount: number (required)
- base_total_due: number (required)
- discount_tax_compensation_amount: number (required)
- created_at: datetime (required)
- customer_email: string (required)
- entity_id: string (required)
- global_currency_code: string (required)
- grand_total: number (required)
- order_currency_code: string (required)
- shipping_amount: number (required)
- shipping_description: string (required)
- shipping_incl_tax: number (required)
- shipping_tax_amount: number (required)
- state: string (required)
- status: string (required)
- store_currency_code: string (required)
- store_name: string (required)
- subtotal: number (required)
- subtotal_incl_tax: number (required)
- tax_amount: number (required)
- total_due: number (required)
- total_item_count: number (required)
- total_qty_ordered: number (required)
- updated_at: string (required)
- increment_id: string (required)
- weight: number (required)
- items: (array of OrderHistoryProduct) (required)
  Items: OrderHistoryProduct
  - base_original_price: number (required)
  - qty_ordered: number (required)
  - qty_sent: number (required)
  - base_price: number (required)
  - base_price_incl_tax: number (required)
  - base_row_total: number (required)
  - base_row_total_incl_tax: number (required)
  - base_tax_amount: number (required)
  - item_id: string (required)
  - name: string (required)
  - order_id: string (required)
  - original_price: number (required)
  - price: number (required)
  - price_incl_tax: number (required)
  - product_id: string (required)
  - product_type: string (required)
  - row_total: number (required)
  - row_total_incl_tax: number (required)
  - sku: string (required)
  - store_id: number (required)
  - tax_amount: number (required)
  - tax_percent: number (required)
  - updated_at: string (required)
  - is_clickable: boolean (required)
  - unit_translations: object (required)
    Example
    { "ENG": "Unit", "DEU": "Einheit" }
  - url_path: string (required)
  - image: string (required)
- documents: (array of OrderHistoryDocument) (required)
  Items: OrderHistoryDocument
  - document_id: string (required)
  - document_type: (one of invoice, shipping-document, unknown) (required)
  - document_origin: (one of ERP, Local) (required)
- payment: object (required)
  - additional_information: (array of ) (required)
  - amount_ordered: number (required)
  - base_amount_ordered: number (required)
  - base_shipping_amount: number (required)
  - entity_id: string (required)
  - method: string (required)
  - parent_id: string (required)
  - shipping_amount: number (required)
  - continuePaymentUrl: string (required)
  - history: (array of PaymentHistory) (required)
    Items: PaymentHistory
    - createdAt: datetime (required)
    - status: string (required)
    - id: string (required)
    - methodType: (one of paypal, cashOnDelivery, mollie) (required)
- shipping_address: object (required)
  - id: string
  - type: (one of STANDARD, SHIPPING, BILLING, ORDER) (required)
    Specifies what type of address to create
  - street: string (required)
  - postCode: string (required)
  - city: string (required)
  - firstName: string (required)
  - lastName: string
  - email: string
  - landId: string
  - telephone: string
  - isActive: boolean
  - isCompany: boolean
  - vatNumber: string
- billing_address: object (required)
  - id: string
  - type: (one of STANDARD, SHIPPING, BILLING, ORDER) (required)
    Specifies what type of address to create
  - street: string (required)
  - postCode: string (required)
  - city: string (required)
  - firstName: string (required)
  - lastName: string
  - email: string
  - landId: string
  - telephone: string
  - isActive: boolean
  - isCompany: boolean
  - vatNumber: string
  - vat_id: string

/api/payment /cancel

ElasticSearch Queries

/api/catalog/vue_storefront_erpframe /category/_search

/api/catalog/vue_storefront_erpframe/category/_search

Allows to access ElasticSearch database in order to query for Categories

Request

Query Parameters
- request: object
  ElasticSearch URL encoded Query object. For more information, see ElasticSearch DSL Query.
  Example
```
{
  "query": {
    "bool": {
      "filter": {
        "bool": {
          "must": [
            {
              "terms": {
                "visiblity": [
                  2,
                  3,
                  4
                ]
              }
            },
            {
              "terms": {
                "status": [
                  0,
                  1
                ]
              }
            },
            {
              "terms": {
                "category_ids": [
                  65,
                  67
                ]
              }
            }
          ]
        }
      }
    }
  }
}
```
- _source_exclude: string | default: *.msrp_display_actual_price_type,required_options,updated_at,created_at,attribute_set_id,options_container,msrp_display_actual_price_type,has_options,stock.manage_stock,stock.use_config_min_qty,stock.use_config_notify_stock_qty,stock.stock_id,stock.use_config_backorders,stock.use_config_enable_qty_inc,stock.enable_qty_increments,stock.use_config_manage_stock,stock.use_config_min_sale_qty,stock.notify_stock_qty,stock.use_config_max_sale_qty,stock.use_config_max_sale_qty,stock.qty_increments,small_image,sgn,*.sgn
  String which defines which field to omit. It optimizes response body.
- _source_include: string
  String which defines field to include to response.
- from: number | default: 0
  A number of element from which to begin the object pagination.
- size: number
  A number that decides how many elements should be returned in a specific page. See "from" parameter.

/api/catalog/vue_storefront_erpframe /product/_search

/api/catalog/vue_storefront_erpframe/product/_search

Allows to access ElasticSearch database in order to query for Products

Request

Query Parameters
- request: object
  ElasticSearch URL encoded Query object. For more information, see ElasticSearch DSL Query.
  Example
```
{
  "query": {
    "bool": {
      "filter": {
        "bool": {
          "must": [
            {
              "terms": {
                "visiblity": [
                  2,
                  3,
                  4
                ]
              }
            },
            {
              "terms": {
                "status": [
                  0,
                  1
                ]
              }
            },
            {
              "terms": {
                "category_ids": [
                  65,
                  67
                ]
              }
            }
          ]
        }
      }
    }
  }
}
```
- _source_exclude: string | default: *.msrp_display_actual_price_type,required_options,updated_at,created_at,attribute_set_id,options_container,msrp_display_actual_price_type,has_options,stock.manage_stock,stock.use_config_min_qty,stock.use_config_notify_stock_qty,stock.stock_id,stock.use_config_backorders,stock.use_config_enable_qty_inc,stock.enable_qty_increments,stock.use_config_manage_stock,stock.use_config_min_sale_qty,stock.notify_stock_qty,stock.use_config_max_sale_qty,stock.use_config_max_sale_qty,stock.qty_increments,small_image,sgn,*.sgn
  String which defines which field to omit. It optimizes response body.
- _source_include: string
  String which defines field to include to response.
- from: number | default: 0
  A number of element from which to begin the object pagination.
- size: number
  A number that decides how many elements should be returned in a specific page. See "from" parameter.

/api/catalog/vue_storefront_erpframe /attribute/_search

/api/catalog/vue_storefront_erpframe/attribute/_search

Allows to access ElasticSearch database in order to query for Attributes

Request

Query Parameters
- request: object
  ElasticSearch URL encoded Query object. For more information, see ElasticSearch DSL Query.
  Example
```
{
  "query": {
    "bool": {
      "filter": {
        "bool": {
          "must": [
            {
              "terms": {
                "visiblity": [
                  2,
                  3,
                  4
                ]
              }
            },
            {
              "terms": {
                "status": [
                  0,
                  1
                ]
              }
            },
            {
              "terms": {
                "category_ids": [
                  65,
                  67
                ]
              }
            }
          ]
        }
      }
    }
  }
}
```
- _source_exclude: string | default: *.msrp_display_actual_price_type,required_options,updated_at,created_at,attribute_set_id,options_container,msrp_display_actual_price_type,has_options,stock.manage_stock,stock.use_config_min_qty,stock.use_config_notify_stock_qty,stock.stock_id,stock.use_config_backorders,stock.use_config_enable_qty_inc,stock.enable_qty_increments,stock.use_config_manage_stock,stock.use_config_min_sale_qty,stock.notify_stock_qty,stock.use_config_max_sale_qty,stock.use_config_max_sale_qty,stock.qty_increments,small_image,sgn,*.sgn
  String which defines which field to omit. It optimizes response body.
- _source_include: string
  String which defines field to include to response.
- from: number | default: 0
  A number of element from which to begin the object pagination.
- size: number
  A number that decides how many elements should be returned in a specific page. See "from" parameter.

/api/catalog/vue_storefront_erpframe /country/_search

/api/catalog/vue_storefront_erpframe/country/_search

Allows to access ElasticSearch database in order to query for Countries

Request

Query Parameters
- request: object
  ElasticSearch URL encoded Query object. For more information, see ElasticSearch DSL Query.
  Example
```
{
  "query": {
    "bool": {
      "filter": {
        "bool": {
          "must": [
            {
              "terms": {
                "visiblity": [
                  2,
                  3,
                  4
                ]
              }
            },
            {
              "terms": {
                "status": [
                  0,
                  1
                ]
              }
            },
            {
              "terms": {
                "category_ids": [
                  65,
                  67
                ]
              }
            }
          ]
        }
      }
    }
  }
}
```
- _source_exclude: string | default: *.msrp_display_actual_price_type,required_options,updated_at,created_at,attribute_set_id,options_container,msrp_display_actual_price_type,has_options,stock.manage_stock,stock.use_config_min_qty,stock.use_config_notify_stock_qty,stock.stock_id,stock.use_config_backorders,stock.use_config_enable_qty_inc,stock.enable_qty_increments,stock.use_config_manage_stock,stock.use_config_min_sale_qty,stock.notify_stock_qty,stock.use_config_max_sale_qty,stock.use_config_max_sale_qty,stock.qty_increments,small_image,sgn,*.sgn
  String which defines which field to omit. It optimizes response body.
- _source_include: string
  String which defines field to include to response.
- from: number | default: 0
  A number of element from which to begin the object pagination.
- size: number
  A number that decides how many elements should be returned in a specific page. See "from" parameter.

/api/catalog/vue_storefront_erpframe /taxrule/_search

/api/catalog/vue_storefront_erpframe/taxrule/_search

Allows to access ElasticSearch database in order to query for Tax Rules

Request

Query Parameters
- request: object
  ElasticSearch URL encoded Query object. For more information, see ElasticSearch DSL Query.
  Example
```
{
  "query": {
    "bool": {
      "filter": {
        "bool": {
          "must": [
            {
              "terms": {
                "visiblity": [
                  2,
                  3,
                  4
                ]
              }
            },
            {
              "terms": {
                "status": [
                  0,
                  1
                ]
              }
            },
            {
              "terms": {
                "category_ids": [
                  65,
                  67
                ]
              }
            }
          ]
        }
      }
    }
  }
}
```
- _source_exclude: string | default: *.msrp_display_actual_price_type,required_options,updated_at,created_at,attribute_set_id,options_container,msrp_display_actual_price_type,has_options,stock.manage_stock,stock.use_config_min_qty,stock.use_config_notify_stock_qty,stock.stock_id,stock.use_config_backorders,stock.use_config_enable_qty_inc,stock.enable_qty_increments,stock.use_config_manage_stock,stock.use_config_min_sale_qty,stock.notify_stock_qty,stock.use_config_max_sale_qty,stock.use_config_max_sale_qty,stock.qty_increments,small_image,sgn,*.sgn
  String which defines which field to omit. It optimizes response body.
- _source_include: string
  String which defines field to include to response.
- from: number | default: 0
  A number of element from which to begin the object pagination.
- size: number
  A number that decides how many elements should be returned in a specific page. See "from" parameter.

/api/_CheckService

Body

/api/user

Headers

Body

Body

Description

Body

Body

Description

Body

Query Parameters

Body

Body

Body

Query Parameters

Body

Body

Body

Body

Body

Body

Query Parameters

Body

/api/customers

Query Parameters

Body

Query Parameters

Body

Body

Query Parameters

Body

Query Parameters

Body

Body

/api/cart/create

Query Parameters

Body

Query Parameters

Body

Query Parameters

Body

Query Parameters

Body

Body

Query Parameters

Body

Body

Query Parameters

Body

Query Parameters

Body

Query Parameters

Body

Body

Query Parameters

Body

URI Parameters

Query Parameters

Body

URI Parameters

Query Parameters

Body

URI Parameters

Query Parameters

Body

URI Parameters

Query Parameters

Body

URI Parameters

Query Parameters

Body

/api/order

Query Parameters

Body

Body

Description

Query Parameters

Body

URI Parameters