Core

Core plugin endpoints

Fetch snippets

get

Get a List of snippets

Responses

200

Found snippets

application/json

get

/snippets

GET /snippets HTTP/1.1
Accept: */*

200

Found snippets

Add employee to company

post

Add employee to company

Responses

200Success

post

/b2b/employee/add

POST /b2b/employee/add HTTP/1.1
Accept: */*

200Success

{
  "$ref": "#/components/schemas/SuccessResponse"
}

Save employee

post

Create new employee

Body

anyOptional

Responses

200

Employee

application/json

post

/b2b/employee

POST /b2b/employee HTTP/1.1
Content-Type: application/json
Accept: */*

200

Employee

No content

Get employee

get

Get a employee

Query parameters

isstringRequired

The required id can be found within the "employee" response:

query["response"]["elements"]["employee"]["id"]

Responses

200Success

get

/b2b/employee/{id}

GET /b2b/employee/{id}?is=text HTTP/1.1
Accept: */*

200Success

No content

Delete employee

delete

Delete a employee

Query parameters

idstringRequired

The required id can be found within the "employee" response:

query["response"]["elements"]["employee"]["id"]

Responses

200

success

delete

/b2b/employee/{id}

DELETE /b2b/employee/{id}?id=text HTTP/1.1
Accept: */*

200

success

No content

Update employee

patch

Update existing employee

Query parameters

idstringRequired

The required id can be found within the "employee" response:

query["response"]["elements"]["employee"]["id"]

Body

anyOptional

Responses

200Success

patch

/b2b/employee/{id}

PATCH /b2b/employee/{id}?id=text HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "firstName": "Test",
  "lastName": "Test",
  "email": "[email protected]",
  "department": "Foobar"
}

200Success

{
  "$ref": "#/components/schemas/SuccessResponse"
}

Fetch employees

post

Get a List of employees

Responses

200Success

post

/b2b/employees

POST /b2b/employees HTTP/1.1
Accept: */*

200Success

No content

Fetch customers of employee

post

Get a List of customers

Body

anyOptional

Responses

200Success

post

/b2b/employee-customers

POST /b2b/employee-customers HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

post

Send email with login link

Responses

200

Success

post

/passwordless-login

POST /passwordless-login HTTP/1.1
Accept: */*

200

Success

No content

post

Query parameters

hashstringRequired

hash

Responses

200Success

post

/passwordless-login/{hash}

POST /passwordless-login/{hash}?hash=text HTTP/1.1
Accept: */*

200Success

{
  "$ref": "#/components/responses/ContextTokenResponse"
}

Fetch Customer Activity Types

get

Customer Activity Type

Responses

200Success

get

/sales-representative/customer-activity-type

GET /sales-representative/customer-activity-type HTTP/1.1
Accept: */*

200Success

No content

Fetch Customer Activity Types

get

Customer Activity Type

Responses

200Success

get

/sales-representative/customer-activity-type/list

GET /sales-representative/customer-activity-type/list HTTP/1.1
Accept: */*

200Success

No content

Get Customer Activity Type by ID

post

This route is used to load the Customer Activity Type.

Authorizations

sw-context-tokenstringRequired

Path parameters

customerActivityTypeIdstringRequired

Customer Activity Type ID

Responses

200Success

post

/sales-representative/customer-activity-type/{id}

POST /sales-representative/customer-activity-type/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

Fetch Platform CMS page

get

Get a rendered Platform CMS page

Query parameters

idstringRequired

pageId

Responses

200

rendered Platform CMS page

text/html

get

/platform-cms/{id}

GET /platform-cms/{id}?id=text HTTP/1.1
Accept: */*

200

rendered Platform CMS page

Fetch Order by employeeId

post

This route is used to load the orders by Employee.

Authorizations

sw-context-tokenstringRequired

Path parameters

employeeIdstringRequired

Employee ID

Responses

200Success

post

/sales-representative/customer-activity-order/{id}

POST /sales-representative/customer-activity-order/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

post

This route is used create a Customer Activity.

Body

anyOptional

Responses

200Success

post

/sales-representative/customer-activity

POST /sales-representative/customer-activity HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

put

This route is used update a Customer Activity.

Body

anyOptional

Responses

200Success

put

/sales-representative/customer-activity

PUT /sales-representative/customer-activity HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

get

This route is used to list the Customer Activity.

Body

anyOptional

Responses

200Success

get

/sales-representative/customer-activity/list

GET /sales-representative/customer-activity/list HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

Customer Activity

get

This route is used to load the Customer Activity.

Authorizations

sw-context-tokenstringRequired

Path parameters

customerActivityIdstringRequired

Customer Activity ID

Responses

200Success

get

/sales-representative/customer-activity/{id}

GET /sales-representative/customer-activity/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

delete

This route is used to delete the Customer Activity.

Path parameters

customerActivityIdstringRequired

Customer Activity ID

Responses

200Success

delete

/sales-representative/customer-activity/{id}

DELETE /sales-representative/customer-activity/{id} HTTP/1.1
Accept: */*

200Success

{
  "$ref": "#/components/schemas/SuccessResponse"
}

Import employees

post

Import employees as CSV

Body

Responses

200

Status Info

post

/b2b/employee-import

POST /b2b/employee-import HTTP/1.1
Accept: */*

200

Status Info

No content

Export employees

post

Exports all employees as CSV

Responses

200

The CSV containing all employees

text/csv

post

/b2b/employee-export

POST /b2b/employee-export HTTP/1.1
Accept: */*

200

The CSV containing all employees

Fetch Customer Prices

post

Get a List of Customer Prices

Responses

200Success

post

/customer-prices

POST /customer-prices HTTP/1.1
Accept: */*

200Success

No content

get

Get a List of Login Targets

Responses

200Success

get

/login-targets

GET /login-targets HTTP/1.1
Accept: */*

200Success

No content

Fetch employee order

get

Get a employee order

Query parameters

idstringRequired

id of the order

Responses

200Success

get

/b2b/employee-order/{id}

GET /b2b/employee-order/{id}?id=text HTTP/1.1
Accept: */*

200Success

No content

Fetch employee orders

post

Get a List of employee orders

Responses

200Success

post

/b2b/employee-orders

POST /b2b/employee-orders HTTP/1.1
Accept: */*

200Success

{
  "$ref": "#/components/schemas/OrderRouteResponse"
}

Update sales representative

patch

update existing sales representative

Query parameters

idstringRequired

id of sales representative

Responses

200Success

patch

/sales-representative/{id}

PATCH /sales-representative/{id}?id=text HTTP/1.1
Accept: */*

200Success

{
  "$ref": "#/components/schemas/SuccessResponse"
}

Fetch sales representative for current customer

get

Get sales representative for current customer

Responses

200Success

get

/sales-representative

GET /sales-representative HTTP/1.1
Accept: */*

200Success

{
  "$ref": "#/components/schemas/CustomerResponse"
}

Fetch orders for sales representative

post

Get a list of orders

Responses

200Success

post

/sales-representative/orders

POST /sales-representative/orders HTTP/1.1
Accept: */*

200Success

{
  "$ref": "#/components/schemas/OrderRouteResponse"
}

Fetch employees for sales representative

post

Get a list of employees

Responses

200Success

post

/sales-representative/employees

POST /sales-representative/employees HTTP/1.1
Accept: */*

200Success

No content

Search products

post

Get a List of products

Body

anyOptional

Responses

200

Found products

application/json

post

/b2b/fast-order-product-search

POST /b2b/fast-order-product-search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Found products

No content

Fetch ordered products

post

Get a list od ordered products

Responses

200Success

post

/ordered-products

POST /ordered-products HTTP/1.1
Accept: */*

200Success

No content

Fetch product table

post

Get product table

Body

anyOptional

Responses

200Success

post

/product-table-listing

POST /product-table-listing HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

{
  "$ref": "#/components/responses/ProductListingRouteResponse"
}

Fetch sales statistics

post

Get a sales statistics

Query parameters

customerIdstringRequired

Customer ID

Responses

200Success

post

/sales-representative/sales-statistics

POST /sales-representative/sales-statistics?customerId=text HTTP/1.1
Accept: */*

200Success

No content

Request Account

post

Request Account for new employee

Body

anyOptional

Responses

200

empty response

post

/account-request

POST /account-request HTTP/1.1
Content-Type: application/json
Accept: */*

200

empty response

No content

Fetch Customer Documents

post

Get a List of Customer Documents

Responses

200Success

post

/customer-documents/

POST /customer-documents/ HTTP/1.1
Accept: */*

200Success

No content

Get the document

get

reads the requested document

Responses

200

the document

get

/customer-document/{fileName}

GET /customer-document/{fileName} HTTP/1.1
Accept: */*

200

the document

No content

Send a password recovery mail

post

This operation is Step 1 of the password reset flow. Make sure to implement Step 2 "Reset password with recovery credentials" in order to allow for the complete flow in your application. Sends a recovery mail containing a link with credentials that allows a customer to reset their password.

Authorizations

sw-context-tokenstringRequired

Body

emailstringRequired

E-Mail address to identify the customer

storefrontUrlstringRequired

URL of the storefront to use for the generated reset link. It has to be a domain that is configured in the sales channel domain settings.

Responses

200

If email corresponds to an existing customer, a mail will be sent out to that customer containing a link assembled using the following schema:

Returns a success indicating a successful initialisation of the reset flow.

application/json

post

/b2b/employee/recovery-password

POST /b2b/employee/recovery-password HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "email": "text",
  "storefrontUrl": "text"
}

200

If email corresponds to an existing customer, a mail will be sent out to that customer containing a link assembled using the following schema:

Returns a success indicating a successful initialisation of the reset flow.

No content

Delete Employee Role

delete

Delete an existing Employee Role

Query parameters

idstringRequired

Id of Employee Role to delete

Responses

200

Success

application/json

delete

/b2b/employee-roles/{id}

DELETE /b2b/employee-roles/{id}?id=text HTTP/1.1
Accept: */*

200

Success

No content

Update Employee Role

patch

Update an existing Employee Role

Query parameters

idstringRequired

Id of Employee Role to update

Responses

200

Success

application/json

patch

/b2b/employee-roles/{id}

PATCH /b2b/employee-roles/{id}?id=text HTTP/1.1
Accept: */*

200

Success

No content

Save Employee Role

post

Create a new Employee Role

Responses

200

Success

application/json

post

/b2b/employee-roles/create

POST /b2b/employee-roles/create HTTP/1.1
Accept: */*

200

Success

No content

Fetch Employee Roles

post

Get a List of Employee Roles

Responses

200Success

post

/b2b/employee-roles

POST /b2b/employee-roles HTTP/1.1
Accept: */*

200Success

No content

Switch address

get

replace billing or shipping address

Query parameters

addressIdstringRequired

Id of the address to be set

typeundefined · enumRequired

type of address to switch

Possible values:

Responses

200

Success

get

/b2b/address/switch-{type}/{addressId}

GET /b2b/address/switch-{type}/{addressId}?addressId=text&type=billing HTTP/1.1
Accept: */*

200

Success

No content

Search customers

post

search for customers

Body

anyOptional

Responses

200Success

post

/sales-representative/customer-search

POST /sales-representative/customer-search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

Fetch sales ranking

post

Get a sales ranking

Body

customerIdstringOptional

Customer

Pattern: ^[0-9a-f]{32}$

Responses

200Success

post

/sales-representative/customer-sales-ranking

POST /sales-representative/customer-sales-ranking HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "customerId": "text"
}

200Success

No content

Fetch customers

post

Get a List customers

Responses

200Success

post

/sales-representative/customers

POST /sales-representative/customers HTTP/1.1
Accept: */*

200Success

No content

Fetch last orders of customer

post

Get a List of last orders of customer

Responses

200

Found orders

application/json

post

/sales-representative/customer-last-orders

POST /sales-representative/customer-last-orders HTTP/1.1
Accept: */*

200

Found orders

No content

Fetch orders of customer

get

Get a List of orders of customer

Authorizations

sw-context-tokenstringRequired

Query parameters

customerIdstringRequired

customer id

Responses

200

An array of orders from the requested customer

application/json

get

/sales-representative/customer-orders/{customerId}

GET /sales-representative/customer-orders/{customerId}?customerId=text HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

An array of orders from the requested customer

No content

Fetch Employee Permissions

post

Get a List of Employee Permissions

Responses

200Success

post

/b2b/employee-permissions

POST /b2b/employee-permissions HTTP/1.1
Accept: */*

200Success

No content

Get employee invitations

get

Get employee invitations

Responses

200Success

get

/b2b/employee-invitations

GET /b2b/employee-invitations HTTP/1.1
Accept: */*

200Success

No content

Get employee invitation

get

Get employee invitation

Query parameters

idstringRequired

employee invitation id

Responses

200Success

get

/b2b/employee-invitation/{id}

GET /b2b/employee-invitation/{id}?id=text HTTP/1.1
Accept: */*

200Success

No content

Delete employee invitation

delete

Delete employee invitation

Query parameters

idstringRequired

employee invitation id

Responses

200

Success

delete

/b2b/employee-invitation/{id}

DELETE /b2b/employee-invitation/{id}?id=text HTTP/1.1
Accept: */*

200

Success

No content

Create employee from invite

post

Import employees as CSV

Query parameters

hashstringRequired

hash from invitation

Responses

200

Status Info

application/json

post

/invitation-employee/{hash}

POST /invitation-employee/{hash}?hash=text HTTP/1.1
Accept: */*

200

Status Info

No content

Create an invitation

post

creates an invitation for an employee

Responses

200

Status Info

application/json

post

/create-invitation

POST /create-invitation HTTP/1.1
Accept: */*

200

Status Info

No content

Fetch express checkout setting

get

Get express checkout setting

Responses

200Success

get

/express-checkout-setting

GET /express-checkout-setting HTTP/1.1
Accept: */*

200Success

No content

Update express checkout setting

patch

Update express checkout setting

Body

anyOptional

Responses

200

Success

application/json

patch

/express-checkout-setting

PATCH /express-checkout-setting HTTP/1.1
Content-Type: application/json
Accept: */*

200

Success

No content

Fetch Employee Permission Groups

post

Get a List of Employee Permission Groups

Responses

200Success

post

/b2b/employee-permission-groups

POST /b2b/employee-permission-groups HTTP/1.1
Accept: */*

200Success

No content

Add products to cart

post

add products to cart

Body

anyOptional

Responses

200

Success

application/json

post

/b2b/add-to-cart

POST /b2b/add-to-cart HTTP/1.1
Content-Type: application/json
Accept: */*

200

Success

No content

list products

post

Get a List of products

Body

anyOptional

Responses

200

Found products

application/json

post

/b2b/product-details

POST /b2b/product-details HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Found products

No content

Search products

post

Get a list of products

Body

anyOptional

Responses

200Success

post

/platform-product-search

POST /platform-product-search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

{
  "$ref": "#/components/responses/ProductSuggestRouteResponse"
}

get price for product

post

Calculates the price for a given product and quantity

Query parameters

quantitynumberRequired

quantity of product

idstringRequired

product id

Responses

200Success

post

/product-price/{id}/{quantity}

POST /product-price/{id}/{quantity}?quantity=1&id=text HTTP/1.1
Accept: */*

200Success

No content

get

Fetch platform menu

Query parameters

depthintegerRequired

depth

Responses

200

Found Fetch platform menu

application/json

get

/b2b/platform-menu

GET /b2b/platform-menu?depth=1 HTTP/1.1
Accept: */*

200

Found Fetch platform menu

No content

post

Fetch platform menu

Query parameters

depthintegerRequired

depth

Responses

200

Found Fetch platform menu

application/json

post

/b2b/platform-menu

POST /b2b/platform-menu?depth=1 HTTP/1.1
Accept: */*

200

Found Fetch platform menu

No content

Last updated 21 days ago

Was this helpful?

hashtagFetch snippets

hashtagAdd employee to company

hashtagSave employee

hashtagGet employee

hashtagDelete employee

hashtagUpdate employee

hashtagFetch employees

hashtagFetch customers of employee

hashtagSend email with login link

hashtagLogin without password

hashtagFetch Customer Activity Types

hashtagFetch Customer Activity Types

hashtagGet Customer Activity Type by ID

hashtagFetch Platform CMS page

hashtagFetch Order by employeeId

hashtagCustomer Activity

hashtagImport employees

hashtagExport employees

hashtagFetch Customer Prices

hashtagFetch Login Targets

hashtagFetch employee order

hashtagFetch employee orders

hashtagUpdate sales representative

hashtagFetch sales representative for current customer

hashtagFetch orders for sales representative

hashtagFetch employees for sales representative

hashtagSearch products

hashtagFetch ordered products

hashtagFetch product table

hashtagFetch sales statistics

hashtagRequest Account

hashtagFetch Customer Documents

hashtagGet the document

hashtagSend a password recovery mail

hashtagDelete Employee Role

hashtagUpdate Employee Role

hashtagSave Employee Role

hashtagFetch Employee Roles

hashtagSwitch address

hashtagSearch customers

hashtagFetch sales ranking

hashtagFetch customers

hashtagFetch last orders of customer

hashtagFetch orders of customer

hashtagFetch Employee Permissions

hashtagGet employee invitations

hashtagGet employee invitation

hashtagDelete employee invitation

hashtagCreate employee from invite

hashtagCreate an invitation

hashtagFetch express checkout setting

hashtagUpdate express checkout setting

hashtagFetch Employee Permission Groups

hashtagAdd products to cart

hashtaglist products

hashtagSearch products

hashtagget price for product

hashtagFetch platform menu

hashtagFetch platform menu

Fetch snippets

Add employee to company

Save employee

Get employee

Delete employee

Update employee

Fetch employees

Fetch customers of employee

Send email with login link

Login without password

Fetch Customer Activity Types

Fetch Customer Activity Types

Get Customer Activity Type by ID

Fetch Platform CMS page

Fetch Order by employeeId

Customer Activity

Import employees

Export employees

Fetch Customer Prices

Fetch Login Targets

Fetch employee order

Fetch employee orders

Update sales representative

Fetch sales representative for current customer

Fetch orders for sales representative

Fetch employees for sales representative

Search products

Fetch ordered products

Fetch product table

Fetch sales statistics

Request Account

Fetch Customer Documents

Get the document

Send a password recovery mail

Delete Employee Role

Update Employee Role

Save Employee Role

Fetch Employee Roles

Switch address

Search customers

Fetch sales ranking

Fetch customers

Fetch last orders of customer

Fetch orders of customer

Fetch Employee Permissions

Get employee invitations

Get employee invitation

Delete employee invitation

Create employee from invite

Create an invitation

Fetch express checkout setting

Update express checkout setting

Fetch Employee Permission Groups

Add products to cart

list products

Search products

get price for product

Fetch platform menu

Fetch platform menu