Back

Favorites

Basket

Text

Recommendations

Order

Menus

Logging

Customer

Menuitemrelations

ProductLocations

Auth

Context

apistate

Country

UserValues

ImageSizeType

Manufacturers

Media

Currencies

Product

SalesPersons

Languages

DocumentModel

BasketLine

AgeVerification

Locations

Favorites methods

Versionsv3

Favorites v3

HTTP method URL Description Authentication HMAC authorization
DELETE /services/v3/favorites Deletes all favorite lists that are deleteable. Required -
POST /services/v3/favorites Creates a new favorite list. Required -
GET /services/v3/favorites/{id} Gets a favorite list by its id. Required -
DELETE /services/v3/favorites/{id} Deletes a favorite list by its id. Required -
PUT /services/v3/favorites/{id} Updates a favorite list by its id. Required -
PATCH /services/v3/favorites/{id} Updates a favorite list by its id. Required -
GET /services/v3/favorites/{id}/items Gets favorite list items by favorite list ID. Required -
POST /services/v3/favorites/{id}/items Adds an item to the favorite list. Required -
DELETE /services/v3/favorites/{id}/items Removes all removable items from the favorite list. Required -
DELETE /services/v3/favorites/{id}/items/{itemId} Removes a specific item from the favorite list. Required -
POST /services/v3/favorites/{id}/merge Merges items from another favorite list into this one. Required -
PUT /services/v3/favorites/{id}/takeownership If a favorite list has policy rogue, you can take ownership of it, and thereby re-gain full control of it. A favorite list becomes rogue if it was created in an anonymous user context and then carried on into an authenticated context (logged in). Required -
GET /services/v3/favorites?tag={tag} Gets all favorite lists, optionally lists filtered by tag. Required -

methods

Versions

Basket methods

Versionsv3v2v1

Basket v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/baskets Lists baskets available in context of the request. Depending on the shop configuration, you may get basket(s) from your last visit. Note: You should use the 'auth' api before attempting to use any basket api in order to setup a ticket for using baskets. Required -
POST /services/v3/baskets Creates a new basket. Required -
GET /services/v3/baskets/{basketId} Gets a specific basket and its content by its id. Required -
DELETE /services/v3/baskets/{basketId} Deletes the basket. Required -
PATCH /services/v3/baskets/{basketId}/annotation Updates basket annotations such as name, comment or delivery date. Required -
PUT /services/v3/baskets/{basketId}/annotation Updates basket annotations such as name, comment or delivery date. Required -
PUT /services/v3/baskets/{basketId}/billto Currently not supported. Required -
POST /services/v3/baskets/{basketId}/checkout Turns the basket into an order. Required -
GET /services/v3/baskets/{basketId}/coupons Lists coupons in basket. Required -
POST /services/v3/baskets/{basketId}/coupons Adds a coupon to basket. Required -
DELETE /services/v3/baskets/{basketId}/coupons Removes all coupons from basket. Required -
DELETE /services/v3/baskets/{basketId}/coupons/{couponId} Removes a specific coupon from basket. Required -
GET /services/v3/baskets/{basketId}/lines Gets basket lines. Required -
POST /services/v3/baskets/{basketId}/lines Adds one or more items as lines to basket. Required -
DELETE /services/v3/baskets/{basketId}/lines Deletes all lines from basket. Required -
DELETE /services/v3/baskets/{basketId}/lines/{lineId} Deletes a specific line from basket. Required -
GET /services/v3/baskets/{basketId}/paymentmethods Lists available payment methods for the basket. Required -
POST /services/v3/baskets/{basketId}/paymentmethods Set payment method to the basket. Required -
GET /services/v3/baskets/{basketId}/progress Returns the progress of the basket on its way to becoming a fully accepted order. This returns a list of actions and their completeness required to check out the basket. Required -
POST /services/v3/baskets/{basketId}/rollback Rollback a previously started checkout flow. Required -
PUT /services/v3/baskets/{basketId}/sellto Updates "sell-to" address of the basket. Required -
PUT /services/v3/baskets/{basketId}/shipto Updates "ship-to" address of the basket. Required -
GET /services/v3/baskets/{basketId}/state Gets the state held by the basket. Basket records state information as this is a vital informatio that directly affects product availability and pricing. Unlike many other resources, the basket information is processed based on the state of the basket, and not based on the context provided by the clients state. You should therefore take care to sync these states between client and basket and / or otherwise make any differences in state obvious to end users in a way that forms a natural flow for end users. The response format is the same as the context api. The context helps you identify any discrepancies of the current client-held context. Required -
PUT /services/v3/baskets/{basketId}/state Updates basket context such as location, currency and language. Required -
GET /services/v3/baskets/{basketId}/status OBSOLETED ENDPOINT! Do not use this endpoint - use /progress endpoint instead. This endpoint will be removed any time soon. Required -
GET /services/v3/baskets/{basketId}/uservalues Gets all user values from basket. Required -
POST /services/v3/baskets/{basketId}/uservalues Creates or updates user values. Required -
PUT /services/v3/baskets/{basketId}/uservalues Creates or updates user values. Required -
DELETE /services/v3/baskets/{basketId}/uservalues Deletes all user values from basket. Required -
GET /services/v3/baskets/{basketId}/uservalues/{key} Gets a specific user value by specified key from basket. If checksum is supplied, the user value is streamed in the response instead of in json output. Required -
DELETE /services/v3/baskets/{basketId}/uservalues/{key} Deletes a user value by specified key from basket. Required -
PUT /services/v3/baskets/{basketId}/uservalues/{key} Updates a user value by specified key from basket. Required -
POST /services/v3/baskets/{id}/merge Merges data from another basket into this basket. Basically, this imports lines, coupons and redeemed giftcards into this basket. Required -
PUT /services/v3/baskets/{id}/takeownership Takes ownership of a "rogue" basket. If a basket has policy rogue, you can take ownership of it, and thereby re-gain full control of it. A rogue basket is a basket that was created prior to logging in and subsequently transferred to the login by authenticating as a non-anonymous user. Required -

Basket v2

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v2/basket Gets visible basket or baskets, depending on shop allows multiple basket - -
POST /sessionservices/v2/basket Creates a new basket. Note: This will advertently create a session. - -
GET /sessionservices/v2/basket/{id} Gets the basket with the specified ID. If this basket does not exist, or you do not have permissions, a 404 is returned. - -
GET /sessionservices/v2/basket/current Gets current basket. If a shop allows multiple baskets, the method returns active basket. - -
GET /sessionservices/v2/basket/current/coupon List coupons in basket. - -
POST /sessionservices/v2/basket/current/coupon Adds the coupon to basket and returns a message wether or not it succeeded. A failure adding (if not found, duplicate, already exists etc) will result in a code 400. - -
DELETE /sessionservices/v2/basket/current/coupon Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400. - -
DELETE /sessionservices/v2/basket/current/coupon/{couponId} Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400. - -

Basket v1

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v1/basket Gets visible basket or baskets, depending on shop allows multiple basket - -
GET /sessionservices/v1/basket/{id} Gets the basket with the specified ID. If this basket does not exist, or you do not have permissions, a 404 is returned. - -
GET /sessionservices/v1/basket/current Gets current basket. If a shop allows multiple baskets, the method returns active basket. - -

Text methods

Versionsv3

Text v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/texts Return a list of text blocks Not allowed -

Recommendations methods

Versionsv3

Recommendations v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/recommendations?itemKeys={itemKeys} Returns product recommendations based on the a provided JSON formatted array of item keys, f.inst [{"itemId":6536309,"typeOfItem":"product"}], and other parameters. Item keys that do not have the type "product" will be ignored. Not allowed -

Order methods

Versionsv3v2v1

Order v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/orders/{orderGuid} Gets a specific order and its content by its id. Not allowed -
GET /services/v3/orders/{orderGuid}/lines Gets order lines. Not allowed -
GET /services/v3/orders/{orderGuid}/uservalues Gets all user values from order. Not allowed -
GET /services/v3/orders/{orderGuid}/uservalues/{key} Gets a specific user value by specified key from order. If checksum is supplied, the user value is streamed in the response instead of in json output. Not allowed -
GET /services/v3/orders/{orderId} Gets a specific order and its content by its id. Required -
GET /services/v3/orders/{orderId}/lines Gets order lines. Required -
GET /services/v3/orders/{orderId}/uservalues Gets all user values from order. Required -
GET /services/v3/orders/{orderId}/uservalues/{key} Gets a specific user value by specified key from order. If checksum is supplied, the user value is streamed in the response instead of in json output. Required -
GET /services/v3/orders?search={search}&fromDate={fromDate}&toDate={toDate}&p={p}&rp={rp} Lists orders available in context of the request. The result set is ordered by creation date descending (newest orders are returned first). Depending on the shop configuration, you may get order(s) from your last visit. Note: You should use the 'auth' api before attempting to use any order api in order to setup a ticket for using orders. Required -

Order v2

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v2/order Gets list of orders for curently logged in customer. If there is no current customer or you do not have permissions, a 404 is returned. - -
GET /sessionservices/v2/order/{id} Gets order with the specified ID. If no current customer is logged in or you do not have permissions, a 404 is returned. - -

Order v1

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v1/order Gets list of orders for curently logged in customer. If there is no current customer or you do not have permissions, a 404 is returned. - -
GET /sessionservices/v1/order/{id} Gets order with the specified ID. If no current customer is logged in or you do not have permissions, a 404 is returned. - -

Menus methods

Versionsv3

Menus v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/menus Returns the entire menu tree. Not allowed -
GET /services/v3/menus/{kind} Returns the entire menu for the kind requested. Not allowed -
GET /services/v3/menus/{kind}/{id} Returns a specific menu item. Not allowed -
GET /services/v3/menus/{kind}/{id}/images/{imageId}/stream/{imageSizeTypeId}?rev={rev} Returns a http stream for the image. Not allowed -

Logging methods

Versionsv3

Logging v3

HTTP method URL Description Authentication HMAC authorization
POST /services/v3/logs Not allowed Required
POST /services/v3/logs/test Not allowed Required

Customer methods

Versionsv3

Customer v3

HTTP method URL Description Authentication HMAC authorization
POST /services/v3/customers Creates a new customer and associated login. Not allowed -
GET /services/v3/customers/current Get the customer and login information that corresponds to the supplied authentication. Required -
DELETE /services/v3/customers/current Delete Current Customer Required -
PATCH /services/v3/customers/current Updates properties on authenticated customer. Required -
POST /services/v3/customers/current/delete Delete Current Customer Required -
PATCH /services/v3/customers/current/logins/current Updates properties on the login authenticated. Required -
PUT /services/v3/customers/current/selltoaddress Update sell to address on authenticated customer. Required -
GET /services/v3/customers/current/shipToAddresses Get the customer all shipement addresses. Required -
POST /services/v3/customers/current/shipToAddresses Creates a new customer delivery address Required -
DELETE /services/v3/customers/current/shipToAddresses Delete Current Customer all delivery address Required -
GET /services/v3/customers/current/shipToAddresses/{shipToAddressId} Get the customer specific address. Required -
PUT /services/v3/customers/current/shipToAddresses/{shipToAddressId} Updates a customer delivery address Required -
DELETE /services/v3/customers/current/shipToAddresses/{shipToAddressId} Delete Current Customer specific delivery address Required -
GET /services/v3/customers/policies Get policies that applies to customer and login creation. Not allowed -

Menuitemrelations methods

Versionsv3

Menuitemrelations v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/menuitemrelations?itemKeys={itemKeys} Not allowed -

ProductLocations methods

Versionsv3

ProductLocations v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/productlocations?itemKeys={itemKeys} Returns ProductLocations identifier by a json formatted array of item keys, i.e. [{"itemId":1212002,"typeOfItem":"product"}] Not allowed -

methods

Versions

methods

Versions

methods

Versions

methods

Versions

methods

Versions

Auth methods

Versionsv3

Auth v3

HTTP method URL Description Authentication HMAC authorization
POST /services/v3/auth/authenticate Generates authentication and ticket required or recommended for various api resources. Optional -
POST /services/v3/auth/hello Registers an app with the hosting webshop using a known api key. Depending on the level of trust to the app, the api can return enough info to complete the registration, or the shop owner has to take additional steps to complete the registration. Not allowed -
POST /services/v3/auth/passwordreset Send password reset email for specific Customer or SalesPerson by using Email Or UserName Not allowed -
POST /services/v3/auth/renew Renews authentication and ticket required or recommended for various api resources. It is recommended calling this resource according to the ttl of authentication response.. If switching hostname, you should also renew, as the authenication and ticket is bound to a specific shop.. Required -
POST /services/v3/auth/setcustomerscope Set the specific customer in scope of salesperson authentication. Required -
POST /services/v3/auth/verifyhello Registers an app with the hosting webshop using a known api key. Depending on the level of trust to the app, the api can return enough info to complete the registration, or the shop owner has to take additional steps to complete the registration. Not allowed Required

Context methods

Versionsv3v1

Context v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/context Returns context information such as currency, language, country. If no parameters are specified in the GET request, it returns default context information for the shop, e.g. currency, language, country. Optional -

Context v1

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v1/context Gets current context information - -
POST /sessionservices/v1/context/changecontext Change the price calculation context. Use null value in properties to reset to default. Note: Changing pricing context may required the shop to be configured to allow this. - -

apistate methods

Versionsv3

apistate v3

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v3/apistate Pulls context information such as currency, language, country, authentication from server state in API format. This allows you to continue working in stateless V3 API's with work started in (legacy) web based eseller. Not allowed -
PUT /sessionservices/v3/apistate set context information such as currency, language, country. Required -

Country methods

Versionsv3

Country v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/countries Not allowed -

UserValues methods

Versionsv2v1

UserValues v2

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v2/basket/{id}/uservalues Gets all user values from the basket with the specified ID - -
POST /sessionservices/v2/basket/{id}/uservalues - -
DELETE /sessionservices/v2/basket/{id}/uservalues Deletes all user values from a basket with specific ID - -
GET /sessionservices/v2/basket/{id}/uservalues/{key} Gets a user value by specified key from basket with specified ID - -
DELETE /sessionservices/v2/basket/{id}/uservalues/{key} Deletes a user value by specified key from current basket - -
PUT /sessionservices/v2/basket/{id}/uservalues/{key} Updates a user value by specified key from basket with specified ID - -
GET /sessionservices/v2/basket/current/uservalues Gets all user values from current basket - -
POST /sessionservices/v2/basket/current/uservalues - -
DELETE /sessionservices/v2/basket/current/uservalues Deletes all user values from current basket - -
GET /sessionservices/v2/basket/current/uservalues/{key} Gets a user value by specified key from current basket - -
DELETE /sessionservices/v2/basket/current/uservalues/{key} Deletes a user value by specified key from current basket - -

UserValues v1

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v1/basket/{id}/uservalues Gets all user values from the basket with the specified ID - -
POST /sessionservices/v1/basket/{id}/uservalues Creates or updates a user value to a basket with specified ID - -
DELETE /sessionservices/v1/basket/{id}/uservalues Deletes all user values from a basket with specific ID - -
GET /sessionservices/v1/basket/{id}/uservalues/{key} Gets a user value by specified key from basket with specified ID - -
DELETE /sessionservices/v1/basket/{id}/uservalues/{key} Deletes a user value by specified key from current basket - -
PUT /sessionservices/v1/basket/{id}/uservalues/{key} Updates a user value by specified key from basket with specified ID - -
GET /sessionservices/v1/basket/current/uservalues Gets all user values from current basket - -
POST /sessionservices/v1/basket/current/uservalues Creates or updates a user value to current basket - -
DELETE /sessionservices/v1/basket/current/uservalues Deletes all user values from current basket - -
GET /sessionservices/v1/basket/current/uservalues/{key} Gets a user value by specified key from current basket - -
DELETE /sessionservices/v1/basket/current/uservalues/{key} Deletes a user value by specified key from current basket - -

ImageSizeType methods

Versionsv3

ImageSizeType v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/imagesizetypes Returns available imagesizetypes for the 'current' shop/layout Not allowed -

Manufacturers methods

Versionsv3

Manufacturers v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/manufacturers Returns a list of manufacturers Not allowed -

Media methods

Versionsv3

Media v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/media Not allowed -
GET /services/v3/media/{name} Not allowed -

Currencies methods

Versionsv3

Currencies v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/currencies List currencies. Not allowed -

Product methods

Versionsv3

Product v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/products/{productId}/images/{imageId}/stream/{imageSizeTypeId}?rev={rev} Returns a http stream for the image. Not allowed -
GET /services/v3/products/{productId}/productmenus Not allowed -
GET /services/v3/products/{productId}/relatedproducts?tag={tag} Returns a product list of related products. Not allowed -
GET /services/v3/products/list Returns a product list and meta data structures. Not allowed -
GET /services/v3/products?extItemKeys={extItemKeys} Returns multiple products identifier by a json formatted array of item keys using external id, i.e. [{"itemId":"E6536309","typeOfItem":"product"}] Not allowed -
GET /services/v3/products?itemKeys={itemKeys} Returns multiple products identifier by a json formatted array of item keys, i.e. [{"itemId":6536309,"typeOfItem":"product"}] Not allowed -

SalesPersons methods

Versionsv3

SalesPersons v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/salespersons/current Get the salesperson and login information that corresponds to the supplied authentication. Required -
GET /services/v3/salespersons/current/customers Get available customers for current salesperson. Required -

Languages methods

Versionsv3

Languages v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/languages Return a list of languages which are enabled and against viewshop parameters Not allowed -

DocumentModel methods

Versionsv3

DocumentModel v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/docmodel/{documentType}/{documentKey} Returns a document. Not allowed -

BasketLine methods

Versionsv2

BasketLine v2

HTTP method URL Description Authentication HMAC authorization
GET /sessionservices/v2/basket/current/line Gets lines from current basket. - -
POST /sessionservices/v2/basket/current/line Adds lines to basket and returns all newly created lines from current basket. Accepts an array of BasketLineBody's to allow for modifying multiple lines at once. - -
PUT /sessionservices/v2/basket/current/line Updates one or more lines in current basket and returns all updated lines. - -
DELETE /sessionservices/v2/basket/current/line Deletes all lines from current basket, aka empty basket. - -
DELETE /sessionservices/v2/basket/current/line/{basketLineId} Deletes a line with given ID from current basket. - -

AgeVerification methods

Versionsv2

AgeVerification v2

HTTP method URL Description Authentication HMAC authorization
POST /sessionservices/v2/basket/current/ageverification set age verification token id of the current basket - -
GET /sessionservices/v2/basket/current/ageverification?newNonce={newNonce} Gets age verification of the current basket - -

Locations methods

Versionsv3

Locations v3

HTTP method URL Description Authentication HMAC authorization
GET /services/v3/locations List locations. Not allowed -
GET /services/v3/locations/{locationId} List a specific location. Not allowed -

Favorites

DELETE/services/v3/favorites

Deletes all favorite lists that are deleteable.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

RESPONSE

Response codes

Http response Description
204 NoContent The delete succeeded.

Favorites

POST/services/v3/favorites

Creates a new favorite list.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Body

  • namestring


    Optional name of the favorite list

  • descriptionstring


    Optional description of the favorite list

  • tagstring


    Optional tag of the favorite list. May be used to fetch the favorite list by tag.

  • sortOrderint32


    Optional sort order of the favorite list (relative to other favorite lists in the response).

  • isActiveboolean


    Indicates if this favorite list is considered the list currently preferred by the user, i.e. where user expects items to be added.

  • isReadonlyboolean


    Indicates if this favorite list is readonly.

Request body

{
"name" : "string",
"description" : "string",
"tag" : "string",
"sortOrder" : "int32",
"isActive" : "boolean",
"isReadonly" : "boolean"}

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • idint32


    The favorite list ID that can be used to query this specific list, for instance for getting favorite list items.

  • policiesfavoritePoliciesEnum


    A list of the policies of the favorite list - that is information about ownership and the possible actions that it allows.

    Possible values:

    DeletableOwnerPersonalRogueShopFrontAccess (Owner | Viewer | Rogue)UpdateableViewer

  • extFavoriteIdstring


    Ext. ID of the favorite list. Can only be set when the favorite list is created from integration.

  • namestring


    Favorite list name.

  • descriptionstring


    Favorite list description.

  • tagstring


    Tag of the favorite list. May be used to fetch favorite lists by tag.

  • isActiveboolean


    Indicates if this favorite list is considered the list currently preferred by the user, i.e. where user expects items to be added.

  • sortOrderint32


    The sort order of the favorite list. May be used to order a list of favorite lists by their sort order.

  • itemCountint32


    The number of different items in the favorite list.

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","policies" : "Deletable | Owner | Personal | Rogue | ShopFrontAccess (Owner | Viewer | Rogue) | Updateable | Viewer","extFavoriteId" : "string","name" : "string","description" : "string","tag" : "string","isActive" : "boolean","sortOrder" : "int32","itemCount" : "int32"}}

Favorites

GET/services/v3/favorites/{id}

Gets a favorite list by its id.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • idint32


    The favorite list ID that can be used to query this specific list, for instance for getting favorite list items.

  • policiesfavoritePoliciesEnum


    A list of the policies of the favorite list - that is information about ownership and the possible actions that it allows.

    Possible values:

    DeletableOwnerPersonalRogueShopFrontAccess (Owner | Viewer | Rogue)UpdateableViewer

  • extFavoriteIdstring


    Ext. ID of the favorite list. Can only be set when the favorite list is created from integration.

  • namestring


    Favorite list name.

  • descriptionstring


    Favorite list description.

  • tagstring


    Tag of the favorite list. May be used to fetch favorite lists by tag.

  • isActiveboolean


    Indicates if this favorite list is considered the list currently preferred by the user, i.e. where user expects items to be added.

  • sortOrderint32


    The sort order of the favorite list. May be used to order a list of favorite lists by their sort order.

  • itemCountint32


    The number of different items in the favorite list.

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","policies" : "Deletable | Owner | Personal | Rogue | ShopFrontAccess (Owner | Viewer | Rogue) | Updateable | Viewer","extFavoriteId" : "string","name" : "string","description" : "string","tag" : "string","isActive" : "boolean","sortOrder" : "int32","itemCount" : "int32"}}

Favorites

DELETE/services/v3/favorites/{id}

Deletes a favorite list by its id.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

RESPONSE

Response codes

Http response Description
204 NoContent The delete succeeded.

Favorites

PUT/services/v3/favorites/{id}

Updates a favorite list by its id.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

Parameters from Body

  • namestring


    Optional name of the favorite list

  • descriptionstring


    Optional description of the favorite list

  • tagstring


    Optional tag of the favorite list. May be used to fetch the favorite list by tag.

  • sortOrderint32


    Optional sort order of the favorite list (relative to other favorite lists in the response).

  • isActiveboolean


    Indicates if this favorite list is considered the list currently preferred by the user, i.e. where user expects items to be added.

  • isReadonlyboolean


    Indicates if this favorite list is readonly.

Request body

{
"name" : "string",
"description" : "string",
"tag" : "string",
"sortOrder" : "int32",
"isActive" : "boolean",
"isReadonly" : "boolean"}

RESPONSE

Response codes

Http response Description
204 NoContent The update succeeded.

Favorites

PATCH/services/v3/favorites/{id}

Updates a favorite list by its id.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

Parameters from Body

  • namestring


    Optional name of the favorite list

  • descriptionstring


    Optional description of the favorite list

  • tagstring


    Optional tag of the favorite list. May be used to fetch the favorite list by tag.

  • sortOrderint32


    Optional sort order of the favorite list (relative to other favorite lists in the response).

  • isActiveboolean


    Indicates if this favorite list is considered the list currently preferred by the user, i.e. where user expects items to be added.

  • isReadonlyboolean


    Indicates if this favorite list is readonly.

Request body

{
"name" : "string",
"description" : "string",
"tag" : "string",
"sortOrder" : "int32",
"isActive" : "boolean",
"isReadonly" : "boolean"}

RESPONSE

Response codes

Http response Description
204 NoContent The update succeeded.

Favorites

GET/services/v3/favorites/{id}/items

Gets favorite list items by favorite list ID.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

  • include=shortdesc

    Causes item short description to be rendered

  • include=shortdescrecurse

    same as shortdesc, but also renders item short description for child items in f.inst bom products.

  • include=longdesc

    Causes item long description to be rendered

  • include=longdescrecurse

    same as longdesc, but also renders item long description for child items in f.inst bom products.

  • include=seo

    SeoMetaTagKeywords is rendered
    SeoHtmlTitle is rendered
    SeoMetaTagDescription is rendered

  • include=inventory

    Show exact inventory

  • include=locations

    show the product locations

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data

  • messages

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

  • kindstring

  • currentItemCountint32

  • totalItemsint32

  • grossItemsint32

  • itemsPerPageint32

  • startIndexint32

  • pagingLinkTemplatestring

  • pageIndexint32

  • totalPagesint32

  • nextLinkstring

  • previousLinkstring

  • attributesobject

  • items

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data

  • messages

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

  • kindstring

  • currentItemCountint32

  • totalItemsint32

  • grossItemsint32

  • itemsPerPageint32

  • startIndexint32

  • pagingLinkTemplatestring

  • pageIndexint32

  • totalPagesint32

  • nextLinkstring

  • previousLinkstring

  • attributesobject

  • variantDimensions

  • namestring

  • values

  • isInItemsboolean

  • namestring

  • indexint32

  • filterFields

  • kindstringEnum

    Possible values:

    productPropertycustomFieldvariantproductPrice

  • filterFieldIdint64

  • extFilterFieldIdstring

  • namestring

  • typestringEnum

    Possible values:

    customstringintegerdecimal

  • isAppliedboolean

  • upperBounddecimal


    If field is a number type, marks the upper bound value for items in the result.

  • lowerBounddecimal


    If field is a number type, marks the lower bound value for items in the result.

  • upperGrossBounddecimal


    If field is a number type, marks the upper bound value for items in the un-filtered result.

  • lowerGrossBounddecimal


    If field is a number type, marks the lower bound value for items in the un-filtered result.

  • values

  • nativeValuestring

  • valuestring

  • countint32


    How many items within the result has this value.

  • isAppliedboolean

  • sortOrderint32

  • productMenus

  • scoresingle

  • navigateUrlstring

  • navigateTextstring

  • navigateTargetstring

  • extMenuItemIdstring

  • menuItemIdint32

  • descriptionstring

  • alternateDescriptionstring

  • uiSortOrderint32

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • articles

  • scoresingle

  • navigateUrlstring

  • navigateTextstring

  • navigateTargetstring

  • uiSortOrderint32

  • descriptionstring

  • metaData


    Meta data and settings for rendering this list.

  • showProductIdboolean

  • showProductEanboolean

  • showProductManufacturerSkuboolean

  • showExtProductIdboolean

  • showAltExtProductIdboolean

  • enableAddToBasketboolean

  • unitOfMeasures

  • unitOfMeasureIdint32

  • extUnitOfMeasureIdstring

  • abbreviationstring


    Short notation of the unit. Try using abbreviations familiar to your clients.

  • siUnitstringEnum


    Indicates if the unit is a standardized unit (f.inst kilo) or non-standardized unit (f.inst box or pallet)

    Lists the 7 fundamental unit of measures based on the International System of Units (SI). See https://en.wikipedia.org/wiki/SI_base_unit .
    An additional 8th unit ia added to describe abstract business specific units, like "each" or "box", that does not translate very well to an SI unit.
    This enumeration is used to describe physical and/or logistical aspects of an .

    Possible values:

    nonSiUnitlengthmasstimeelectricCurrentthermoDynamicTemperatureamountOfSubstanceluminousIntensity

  • conversionFactordecimal


    Indicates how this unit mathematical relates to its base unit.
    Base units will have conversion factor 1.

  • baseUnitOfMeasureIdint32


    If this unit relates to another unit. All units with the same base can be converted between each other.

  • descriptionstring


    A more elaborate description of this unit. Try using terms familiar to your clients.

  • items

  • itemVersionstring

  • extVariantIdstring

  • extItemIdstring

  • itemKeyitemKey


    Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
    The kind of item is determined the the typeOfItem portion if this key.

  • itemIdint32

  • typeOfItemstringEnum

    Possible values:

    producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

  • namestring

  • shortDescriptionstring

  • longDescriptionstring

  • seoMetaTagKeywordsstring

  • seoHtmlTitlestring

  • seoMetaTagDescriptionstring

  • scoredouble

  • variantNamestring

  • variantValuesstring

  • hasVariantsboolean

  • hasSalesPriceboolean

  • showSalesPriceboolean

  • frontPageProductboolean

  • greatBuyboolean

  • noveltyProductboolean

  • deprecatedboolean

  • manufacturerIdint32

  • manufacturerstring

  • manufacturerSkustring

  • hasExpectedDeliveryDateboolean

  • expectedDeliveryDatedateTime

  • shipmentsstring

  • isBuyableboolean

  • isConfiguredProductboolean

  • showAddToBasketboolean

  • showAddToFavoritesboolean

  • boundToInventoryCountboolean

  • stocklevelint32

  • locations

  • locationIdint64

  • extLocationIdstring

  • isBuyableboolean

  • isVisibleInShopboolean

  • stocklevelint32

  • boundToInventoryCountboolean

  • stockAvailabilitystring

  • grossWeight


    Shows an amount in a specific unit with reference to the unit specification.

  • amountdecimal

  • unitOfMeasureIdint32

  • abbreviationstring

  • salesUnit

  • unitOfMeasureIdint32

  • abbreviationstring

  • salesUnitConstraints

  • extSalesUnitConstraintIdstring

  • smallestCountdecimal


    Indicates least common multiple in which that this item can be bought. Quantity bought must be a multiple of this value.
    F.inst if your unit is kilo, 1 indicates you buy in chunks of kilos, 0.5 indicates you buy in chunks of half-kilos (note: scale would then be 1 to allow for a decimal)

  • minimumCountdecimal


    Indicates the minimum number of units clients are required to buy.

  • maximumCountdecimal

  • scaleint32


    Indicates how many decimal places should be shown and accepted for the related unit. this would typically be 1 (one) if buying in chunks of whole units.

  • stockAvailabilitystring

  • salesPrices

  • amount


    Shows an amount in a specific unit with reference to the unit specification.

  • amountdecimal

  • unitOfMeasureIdint32

  • abbreviationstring

  • beforePrice


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • recommendedPrice


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • salesPrice


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • totalSalesPrice


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • descriptionstring

  • discountLabelstring

  • salesPriceLabelstring

  • validFromdateTime


    Date and time in UTC, from when this price takes effect.

  • validTodateTime


    Date and time in UTC when this price is no longer valid.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • customFields

  • customFieldIdint64

  • extCustomFieldIdstring

  • valuestring

  • namestring

  • nativeValuestring

  • variants

  • itemKeyitemKey


    Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
    The kind of item is determined the the typeOfItem portion if this key.

  • itemIdint32

  • typeOfItemstringEnum

    Possible values:

    producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

  • suggestedQuantitydecimal

  • eanstring

  • annotation

  • itemIdint32


    Favorite item ID.
    May be used to remove the item from the favorite list.

  • suggestedQuantitydecimal


    Indicates the quantity of the item in the favorite list.

  • sortOrderint32


    Sort order of the item in the favorite list (relative to other items in the favorite list).
    May be used to order a list of favorite items.

  • links


    List of suggested actions to perform on the resource.

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"id" : "string","apiVersion" : "string","context" : "string","servedBy" : "string","timeServed" : "string","appVersion" : "string","took" : "double","data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","variantDimensions" : [{"name" : "string","values" : [{"isInItems" : "boolean","name" : "string"}],"index" : "int32"}],"filterFields" : [{"kind" : "productProperty | customField | variant | productPrice","filterFieldId" : "int64","extFilterFieldId" : "string","name" : "string","type" : "custom | string | integer | decimal","isApplied" : "boolean","upperBound" : "decimal","lowerBound" : "decimal","upperGrossBound" : "decimal","lowerGrossBound" : "decimal","values" : [{"nativeValue" : "string","value" : "string","count" : "int32","isApplied" : "boolean","sortOrder" : "int32"}]}],"productMenus" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","extMenuItemId" : "string","menuItemId" : "int32","description" : "string","alternateDescription" : "string","uiSortOrder" : "int32","links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}]}],"articles" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","uiSortOrder" : "int32","description" : "string"}],"metaData" : {"showProductId" : "boolean","showProductEan" : "boolean","showProductManufacturerSku" : "boolean","showExtProductId" : "boolean","showAltExtProductId" : "boolean","enableAddToBasket" : "boolean"},"unitOfMeasures" : [{"unitOfMeasureId" : "int32","extUnitOfMeasureId" : "string","abbreviation" : "string","siUnit" : "nonSiUnit | length | mass | time | electricCurrent | thermoDynamicTemperature | amountOfSubstance | luminousIntensity","conversionFactor" : "decimal","baseUnitOfMeasureId" : "int32","description" : "string"}],"items" : [{"itemVersion" : "string","extVariantId" : "string","extItemId" : "string","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"name" : "string","shortDescription" : "string","longDescription" : "string","seoMetaTagKeywords" : "string","seoHtmlTitle" : "string","seoMetaTagDescription" : "string","score" : "double","variantName" : "string","variantValues" : "string","hasVariants" : "boolean","hasSalesPrice" : "boolean","showSalesPrice" : "boolean","frontPageProduct" : "boolean","greatBuy" : "boolean","noveltyProduct" : "boolean","deprecated" : "boolean","manufacturerId" : "int32","manufacturer" : "string","manufacturerSku" : "string","hasExpectedDeliveryDate" : "boolean","expectedDeliveryDate" : "dateTime","shipments" : "string","isBuyable" : "boolean","isConfiguredProduct" : "boolean","showAddToBasket" : "boolean","showAddToFavorites" : "boolean","boundToInventoryCount" : "boolean","stocklevel" : "int32","locations" : [{"locationId" : "int64","extLocationId" : "string","isBuyable" : "boolean","isVisibleInShop" : "boolean","stocklevel" : "int32","boundToInventoryCount" : "boolean","stockAvailability" : "string"}],"grossWeight" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"salesUnit" : [{"unitOfMeasureId" : "int32","abbreviation" : "string"}],"salesUnitConstraints" : [{"extSalesUnitConstraintId" : "string","smallestCount" : "decimal","minimumCount" : "decimal","maximumCount" : "decimal","scale" : "int32"}],"stockAvailability" : "string","salesPrices" : [{"amount" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"beforePrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"recommendedPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"salesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"totalSalesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"description" : "string","discountLabel" : "string","salesPriceLabel" : "string","validFrom" : "dateTime","validTo" : "dateTime"}],"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customFields" : [{"customFieldId" : "int64","extCustomFieldId" : "string","value" : "string","name" : "string","nativeValue" : "string"}],"variants" : [{"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"}}],"suggestedQuantity" : "decimal","ean" : "string","annotation" : {"itemId" : "int32","suggestedQuantity" : "decimal","sortOrder" : "int32","links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}]}}]}}]}}

Favorites

POST/services/v3/favorites/{id}/items

Adds an item to the favorite list.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

Parameters from Body

  • itemKeyitemKey


    Identifier of the item that should be added to the favorite list, e.g. {"itemId":6536309,"typeOfItem":"product"}.

  • itemIdint32

  • typeOfItemstringEnum

    Possible values:

    producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

  • quantitydecimal


    Optional quantity of the item to be added to the favorite list.
    This value is returned as "suggestedQuantity" when getting favorite list items.

  • sortOrderint32


    Sort order for the favorite list item (relative to other items in the list).
    May be used to order a list of favorite list items.

Request body

[{
"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},
"quantity" : "decimal",
"sortOrder" : "int32"}]

RESPONSE

Response codes

Http response Description
204 NoContent The update succeeded.

Favorites

DELETE/services/v3/favorites/{id}/items

Removes all removable items from the favorite list.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

RESPONSE

Response codes

Http response Description
204 NoContent The delete succeeded.

Favorites

DELETE/services/v3/favorites/{id}/items/{itemId}

Removes a specific item from the favorite list.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

  • itemIdint32REQUIRED

RESPONSE

Response codes

Http response Description
204 NoContent The delete succeeded.

Favorites

POST/services/v3/favorites/{id}/merge

Merges items from another favorite list into this one.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

Parameters from Body

  • fromFavoriteIdint32


    The ID of the favorite list from which you wish to import items.

  • mergeTostringEnum


    Defines to which favorite list the items must be imported.
    "This" refers to the favorite ID defined in the request path.

    Possible values:

    this

Request body

{
"fromFavoriteId" : "int32","mergeTo" : "this"}

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}]}

Favorites

PUT/services/v3/favorites/{id}/takeownership

If a favorite list has policy rogue, you can take ownership of it, and thereby re-gain full control of it. A favorite list becomes rogue if it was created in an anonymous user context and then carried on into an authenticated context (logged in).

Authentication header is required with one of the following roles: Visitor, Customer

REQUEST PARAMETERS

Parameters from Uri

  • idint32REQUIRED

RESPONSE

Response codes

Http response Description
204 NoContent The update succeeded.

Favorites

GET/services/v3/favorites?tag={tag}

Gets all favorite lists, optionally lists filtered by tag.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • tagstring

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data

  • messages

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

  • kindstring

  • currentItemCountint32

  • totalItemsint32

  • grossItemsint32

  • itemsPerPageint32

  • startIndexint32

  • pagingLinkTemplatestring

  • pageIndexint32

  • totalPagesint32

  • nextLinkstring

  • previousLinkstring

  • attributesobject

  • items

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • idint32


    The favorite list ID that can be used to query this specific list, for instance for getting favorite list items.

  • policiesfavoritePoliciesEnum


    A list of the policies of the favorite list - that is information about ownership and the possible actions that it allows.

    Possible values:

    DeletableOwnerPersonalRogueShopFrontAccess (Owner | Viewer | Rogue)UpdateableViewer

  • extFavoriteIdstring


    Ext. ID of the favorite list. Can only be set when the favorite list is created from integration.

  • namestring


    Favorite list name.

  • descriptionstring


    Favorite list description.

  • tagstring


    Tag of the favorite list. May be used to fetch favorite lists by tag.

  • isActiveboolean


    Indicates if this favorite list is considered the list currently preferred by the user, i.e. where user expects items to be added.

  • sortOrderint32


    The sort order of the favorite list. May be used to order a list of favorite lists by their sort order.

  • itemCountint32


    The number of different items in the favorite list.

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","policies" : "Deletable | Owner | Personal | Rogue | ShopFrontAccess (Owner | Viewer | Rogue) | Updateable | Viewer","extFavoriteId" : "string","name" : "string","description" : "string","tag" : "string","isActive" : "boolean","sortOrder" : "int32","itemCount" : "int32"}]}}

Basket

GET/services/v3/baskets

Lists baskets available in context of the request. Depending on the shop configuration, you may get basket(s) from your last visit. Note: You should use the 'auth' api before attempting to use any basket api in order to setup a ticket for using baskets.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • include=description

    BillToAddress is not rendered, unless this condition is specified.
    SellToAddress is not rendered, unless this condition is specified.
    ShipToAddress is not rendered, unless this condition is specified.
    Annotations are not rendered, unless this condition is specified.

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data

  • messages

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

  • kindstring

  • currentItemCountint32

  • totalItemsint32

  • grossItemsint32

  • itemsPerPageint32

  • startIndexint32

  • pagingLinkTemplatestring

  • pageIndexint32

  • totalPagesint32

  • nextLinkstring

  • previousLinkstring

  • attributesobject

  • items

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • idint32


    basket Id

  • basketGuidguid


    Gets or sets Guid of basket.

  • dateModifieddateTime


    Date of last modification in UTC

  • namestring


    Gets or sets the name of the basket.

  • policiesbasketPoliciesEnum


    Gets the policies applied to the basket in the current context.

    Possible values:

    ActiveCanCheckoutClosedDeletableLockedOrderCreatedOwnerReadOnly (Closed | Locked | OrderCreated | Rogue)RogueShopFrontAccess (Owner | Supervisor | Rogue)Supervisor

  • billToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • sellToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • shipToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • annotation

  • commentstring

  • deliveryDatedateTime

  • basketTotal


    Gets the total amount for this basket.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • lineCountint32


    How many lines in basket

  • itemCountdecimal


    How many items in basket, i.e. a sum of all quantities.

  • lineTotal


    Gets the total amount for items in basket. This excludes any fees applicable.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • shipments


    Gets a list of shipments applicable to the basket, including fees.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • namestring

  • descriptionstring

  • fee


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • isCollectAtStoreboolean

  • payments


    Gets a list of payments applicable to the basket, including fees.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • extPaymentMethodIdstring

  • namestring

  • descriptionstring

  • fee


    Aplicable fee, added to the total value of basket.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • amountReserved


    Any amount already reserved for payment. Amount due is totalvalue minus sum(AmountReserved)

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • validationMessages

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

  • location


    Gets location to Basket

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • locationIdint64


    The ID of the location.
    May be used to fetch a specific location.

  • extLocationIdstring


    Location ext. ID.

  • posIdstring


    Only relevant to locations integrated with an external POS system.

  • isDefaultboolean


    Defines whether the location is default for the current shop.

  • isBuyableboolean


    Defines whether items may be ordered from this location.

  • showAddToBasketboolean


    Defines wheter "add to basket" buttons should be visible for this location.

  • uiSortorderint32


    Sort order value that may be used to order a list of locations according to this value.

  • locationNamestring


    The name of the location.

  • isVisibleInShopboolean


    Defines whether the location should be shown in the shop.
    This flag does no no influence wether this location can be used to sell from.

  • namestring


    Location address name.

  • name2string


    Location address name2.

  • addressstring


    Location Address.

  • address2string


    Location Address2.

  • citystring


    Location address city.

  • postCodestring


    Location address post code.

  • countystring


    Location address county.

  • countryIdint32


    Location address country.

  • emailAddressstring


    Location e-mail address. May receive a copy of order confirmation e-mails.

  • contactstring


    Location contact.

  • phoneNumberstring


    Location phone number.

  • faxNumberstring


    Location fax number.

  • leadTimetimespan


    Location lead time.
    An off-set in hours from the order is placed to when it may be collected at a physical location.

  • openingHours


    Returns any opening hours defined for the location.

  • validityDatedateTime


    The date of the "special" opening hour.
    Only returned for "special" opening hours.

  • openFromtimespan


    Time of day from when the physical location is open.

  • openTotimespan


    Time of day to when the physical location is open.

  • isClosedboolean


    Flag indicating whether the physical location is open.

  • commentstring


    Optional comment to show for the opening hour (not localized).

  • isOpenForCollectionboolean


    Flag indicating whether the physical location is open for collect orders.

  • collectOpenFromtimespan


    Time of day from when the physical location is open for collect orders.

  • collectOpenTotimespan


    Time of day to when the physical location is open for collect orders.

  • dayOfTheWeekint32


    Numeric representation of the week day.
    0 = Sunday.

  • specialOpeningHours


    Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

  • validityDatedateTime


    The date of the "special" opening hour.
    Only returned for "special" opening hours.

  • openFromtimespan


    Time of day from when the physical location is open.

  • openTotimespan


    Time of day to when the physical location is open.

  • isClosedboolean


    Flag indicating whether the physical location is open.

  • commentstring


    Optional comment to show for the opening hour (not localized).

  • isOpenForCollectionboolean


    Flag indicating whether the physical location is open for collect orders.

  • collectOpenFromtimespan


    Time of day from when the physical location is open for collect orders.

  • collectOpenTotimespan


    Time of day to when the physical location is open for collect orders.

  • dayOfTheWeekint32


    Numeric representation of the week day.
    0 = Sunday.

  • collectTimesdateTime


    Returns any collect times for the context of the request.
    Setting the "timescope" and "interval" query parameters in the request influences what is returned.

  • duePaymentAmount


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • duePaymentVatAmountValidboolean

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","name" : "string","policies" : "Active | CanCheckout | Closed | Deletable | Locked | OrderCreated | Owner | ReadOnly (Closed | Locked | OrderCreated | Rogue) | Rogue | ShopFrontAccess (Owner | Supervisor | Rogue) | Supervisor","billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"annotation" : {"comment" : "string","deliveryDate" : "dateTime"},"basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineCount" : "int32","itemCount" : "decimal","lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"shipments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"isCollectAtStore" : "boolean"}],"payments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"extPaymentMethodId" : "string","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"amountReserved" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"validationMessages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"duePaymentAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"duePaymentVatAmountValid" : "boolean"}]}}

Response codes

Http response Description
Returns a list of baskets availably in the request context.

Basket

POST/services/v3/baskets

Creates a new basket.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • include=description

    BillToAddress is not rendered, unless this condition is specified.
    SellToAddress is not rendered, unless this condition is specified.
    ShipToAddress is not rendered, unless this condition is specified.
    Annotations are not rendered, unless this condition is specified.

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data


    Main properties of a basket.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • idint32


    basket Id

  • basketGuidguid


    Gets or sets Guid of basket.

  • dateModifieddateTime


    Date of last modification in UTC

  • namestring


    Gets or sets the name of the basket.

  • policiesbasketPoliciesEnum


    Gets the policies applied to the basket in the current context.

    Possible values:

    ActiveCanCheckoutClosedDeletableLockedOrderCreatedOwnerReadOnly (Closed | Locked | OrderCreated | Rogue)RogueShopFrontAccess (Owner | Supervisor | Rogue)Supervisor

  • billToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • sellToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • shipToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • annotation

  • commentstring

  • deliveryDatedateTime

  • basketTotal


    Gets the total amount for this basket.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • lineCountint32


    How many lines in basket

  • itemCountdecimal


    How many items in basket, i.e. a sum of all quantities.

  • lineTotal


    Gets the total amount for items in basket. This excludes any fees applicable.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • shipments


    Gets a list of shipments applicable to the basket, including fees.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • namestring

  • descriptionstring

  • fee


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • isCollectAtStoreboolean

  • payments


    Gets a list of payments applicable to the basket, including fees.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • extPaymentMethodIdstring

  • namestring

  • descriptionstring

  • fee


    Aplicable fee, added to the total value of basket.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • amountReserved


    Any amount already reserved for payment. Amount due is totalvalue minus sum(AmountReserved)

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • validationMessages

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

  • location


    Gets location to Basket

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • locationIdint64


    The ID of the location.
    May be used to fetch a specific location.

  • extLocationIdstring


    Location ext. ID.

  • posIdstring


    Only relevant to locations integrated with an external POS system.

  • isDefaultboolean


    Defines whether the location is default for the current shop.

  • isBuyableboolean


    Defines whether items may be ordered from this location.

  • showAddToBasketboolean


    Defines wheter "add to basket" buttons should be visible for this location.

  • uiSortorderint32


    Sort order value that may be used to order a list of locations according to this value.

  • locationNamestring


    The name of the location.

  • isVisibleInShopboolean


    Defines whether the location should be shown in the shop.
    This flag does no no influence wether this location can be used to sell from.

  • namestring


    Location address name.

  • name2string


    Location address name2.

  • addressstring


    Location Address.

  • address2string


    Location Address2.

  • citystring


    Location address city.

  • postCodestring


    Location address post code.

  • countystring


    Location address county.

  • countryIdint32


    Location address country.

  • emailAddressstring


    Location e-mail address. May receive a copy of order confirmation e-mails.

  • contactstring


    Location contact.

  • phoneNumberstring


    Location phone number.

  • faxNumberstring


    Location fax number.

  • leadTimetimespan


    Location lead time.
    An off-set in hours from the order is placed to when it may be collected at a physical location.

  • openingHours


    Returns any opening hours defined for the location.

  • validityDatedateTime


    The date of the "special" opening hour.
    Only returned for "special" opening hours.

  • openFromtimespan


    Time of day from when the physical location is open.

  • openTotimespan


    Time of day to when the physical location is open.

  • isClosedboolean


    Flag indicating whether the physical location is open.

  • commentstring


    Optional comment to show for the opening hour (not localized).

  • isOpenForCollectionboolean


    Flag indicating whether the physical location is open for collect orders.

  • collectOpenFromtimespan


    Time of day from when the physical location is open for collect orders.

  • collectOpenTotimespan


    Time of day to when the physical location is open for collect orders.

  • dayOfTheWeekint32


    Numeric representation of the week day.
    0 = Sunday.

  • specialOpeningHours


    Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

  • validityDatedateTime


    The date of the "special" opening hour.
    Only returned for "special" opening hours.

  • openFromtimespan


    Time of day from when the physical location is open.

  • openTotimespan


    Time of day to when the physical location is open.

  • isClosedboolean


    Flag indicating whether the physical location is open.

  • commentstring


    Optional comment to show for the opening hour (not localized).

  • isOpenForCollectionboolean


    Flag indicating whether the physical location is open for collect orders.

  • collectOpenFromtimespan


    Time of day from when the physical location is open for collect orders.

  • collectOpenTotimespan


    Time of day to when the physical location is open for collect orders.

  • dayOfTheWeekint32


    Numeric representation of the week day.
    0 = Sunday.

  • collectTimesdateTime


    Returns any collect times for the context of the request.
    Setting the "timescope" and "interval" query parameters in the request influences what is returned.

  • duePaymentAmount


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • duePaymentVatAmountValidboolean

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","name" : "string","policies" : "Active | CanCheckout | Closed | Deletable | Locked | OrderCreated | Owner | ReadOnly (Closed | Locked | OrderCreated | Rogue) | Rogue | ShopFrontAccess (Owner | Supervisor | Rogue) | Supervisor","billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"annotation" : {"comment" : "string","deliveryDate" : "dateTime"},"basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineCount" : "int32","itemCount" : "decimal","lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"shipments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"isCollectAtStore" : "boolean"}],"payments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"extPaymentMethodId" : "string","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"amountReserved" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"validationMessages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"duePaymentAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"duePaymentVatAmountValid" : "boolean"}}

Response codes

Http response Description
Returns the content of the created basket.

Basket

GET/services/v3/baskets/{basketId}

Gets a specific basket and its content by its id.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

Returns state headers.

REQUEST PARAMETERS

Parameters from Uri

  • basketIdint32REQUIRED

  • include=description

    BillToAddress is not rendered, unless this condition is specified.
    SellToAddress is not rendered, unless this condition is specified.
    ShipToAddress is not rendered, unless this condition is specified.
    Annotations are not rendered, unless this condition is specified.

RESPONSE

Response fields

  • idstring


    Represents a unique ID for the task carried out by a request.
    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
    The Id is required in Api response.

  • apiVersionstring


    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

  • contextstring


    Echoes the context from the original request.
    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

  • servedBystring


    This states a name of the actual server serving the response.
    This has no practical use other but supplying an ensurance of the platform in service.

  • timeServedstring


    Returns the time in UTC when the request was created.

  • appVersionstring


    Returns the application build version.

  • tookdouble


    Returns the complete time it took to process the request.

  • data


    Main properties of a basket.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • idint32


    basket Id

  • basketGuidguid


    Gets or sets Guid of basket.

  • dateModifieddateTime


    Date of last modification in UTC

  • namestring


    Gets or sets the name of the basket.

  • policiesbasketPoliciesEnum


    Gets the policies applied to the basket in the current context.

    Possible values:

    ActiveCanCheckoutClosedDeletableLockedOrderCreatedOwnerReadOnly (Closed | Locked | OrderCreated | Rogue)RogueShopFrontAccess (Owner | Supervisor | Rogue)Supervisor

  • billToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • sellToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • shipToAddress

  • isEnabledboolean

  • isConfirmedboolean

  • constraints

  • fieldNamestring

  • kindkindOfField

  • fieldPolicystring

  • lookupstring

  • regExValidationstring

  • maxLengthint32

  • lowerBounddecimal

  • upperBounddecimal

  • companyNamestring

  • attentionstring

  • namestring

  • addressstring

  • address2string

  • zipCodestring

  • citystring

  • country

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • countryIdint32

  • extCountryIdstring

  • namestring

  • isDefaultCountryboolean

  • sortOrderint32

  • iso3166Alpha3string

  • iso3166Alpha2string

  • emailstring

  • referencestring

  • phoneNumberstring

  • mobilePhoneNumberstring

  • faxNumberstring

  • vATNumberstring

  • eInvoiceCustomerReferencestring

  • eInvoiceCustomerExtDocNostring

  • eInvoiceCustomerReceiverCodestring

  • eInvoiceCustomerIntPostingNostring

  • annotation

  • commentstring

  • deliveryDatedateTime

  • basketTotal


    Gets the total amount for this basket.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • lineCountint32


    How many lines in basket

  • itemCountdecimal


    How many items in basket, i.e. a sum of all quantities.

  • lineTotal


    Gets the total amount for items in basket. This excludes any fees applicable.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • shipments


    Gets a list of shipments applicable to the basket, including fees.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • namestring

  • descriptionstring

  • fee


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • isCollectAtStoreboolean

  • payments


    Gets a list of payments applicable to the basket, including fees.

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • extPaymentMethodIdstring

  • namestring

  • descriptionstring

  • fee


    Aplicable fee, added to the total value of basket.

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • amountReserved


    Any amount already reserved for payment. Amount due is totalvalue minus sum(AmountReserved)

    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • validationMessages

  • severitystringEnum


    The severity of the message.

    Possible values:

    debuginfowarningerrorfatalsecurity

  • messagestring


    Localized message.

  • resultCodestringEnum


    The result code helps you identify what kind of issue the message is about.

    Possible values:

    okwarningnotFoundconstraintFailureunAuthorizedother

  • errorCodestring


    An invariant text string containing identification of the error,
    i.e. a never-changing non-localized text code usable for programmatic handling of the message.

  • kindstring


    Literal reference to what item this message relates to.
    Together with the reference property, this enables you to locate exactly what item was
    the source for this message.

  • referencestring


    Together with kind, this identifies exactly what item caused the message.

  • location


    Gets location to Basket

  • links

  • rellinkRel


    Specifies what relation this link has to the resource it is declared upon.

  • hrefstring


    Specifies the link to the resource. This would be a relative link.

  • actionlinkAction


    Represents the action suggested to use the resource.

  • titlestring


    The title of the resource, that describes the link.

  • nestedLevelint32


    If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

  • sizeTypeIdint32


    For image resources, this represents the image type of the request.

  • targetContentlinkTargetContent


    An abstract content type describing what kind of data to expect from the resource.

  • targetMediaTypestring


    Describes what media type to expect from the resource in a technical described as mime.

  • locationIdint64


    The ID of the location.
    May be used to fetch a specific location.

  • extLocationIdstring


    Location ext. ID.

  • posIdstring


    Only relevant to locations integrated with an external POS system.

  • isDefaultboolean


    Defines whether the location is default for the current shop.

  • isBuyableboolean


    Defines whether items may be ordered from this location.

  • showAddToBasketboolean


    Defines wheter "add to basket" buttons should be visible for this location.

  • uiSortorderint32


    Sort order value that may be used to order a list of locations according to this value.

  • locationNamestring


    The name of the location.

  • isVisibleInShopboolean


    Defines whether the location should be shown in the shop.
    This flag does no no influence wether this location can be used to sell from.

  • namestring


    Location address name.

  • name2string


    Location address name2.

  • addressstring


    Location Address.

  • address2string


    Location Address2.

  • citystring


    Location address city.

  • postCodestring


    Location address post code.

  • countystring


    Location address county.

  • countryIdint32


    Location address country.

  • emailAddressstring


    Location e-mail address. May receive a copy of order confirmation e-mails.

  • contactstring


    Location contact.

  • phoneNumberstring


    Location phone number.

  • faxNumberstring


    Location fax number.

  • leadTimetimespan


    Location lead time.
    An off-set in hours from the order is placed to when it may be collected at a physical location.

  • openingHours


    Returns any opening hours defined for the location.

  • validityDatedateTime


    The date of the "special" opening hour.
    Only returned for "special" opening hours.

  • openFromtimespan


    Time of day from when the physical location is open.

  • openTotimespan


    Time of day to when the physical location is open.

  • isClosedboolean


    Flag indicating whether the physical location is open.

  • commentstring


    Optional comment to show for the opening hour (not localized).

  • isOpenForCollectionboolean


    Flag indicating whether the physical location is open for collect orders.

  • collectOpenFromtimespan


    Time of day from when the physical location is open for collect orders.

  • collectOpenTotimespan


    Time of day to when the physical location is open for collect orders.

  • dayOfTheWeekint32


    Numeric representation of the week day.
    0 = Sunday.

  • specialOpeningHours


    Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

  • validityDatedateTime


    The date of the "special" opening hour.
    Only returned for "special" opening hours.

  • openFromtimespan


    Time of day from when the physical location is open.

  • openTotimespan


    Time of day to when the physical location is open.

  • isClosedboolean


    Flag indicating whether the physical location is open.

  • commentstring


    Optional comment to show for the opening hour (not localized).

  • isOpenForCollectionboolean


    Flag indicating whether the physical location is open for collect orders.

  • collectOpenFromtimespan


    Time of day from when the physical location is open for collect orders.

  • collectOpenTotimespan


    Time of day to when the physical location is open for collect orders.

  • dayOfTheWeekint32


    Numeric representation of the week day.
    0 = Sunday.

  • collectTimesdateTime


    Returns any collect times for the context of the request.
    Setting the "timescope" and "interval" query parameters in the request influences what is returned.

  • duePaymentAmount


    A special implementation of IPrice, that targets api usage.

  • currencySymbolstring

  • vatPercentagedecimal

  • vatAmountdecimal

  • isPriceIncVatboolean

  • priceIncVatdecimal

  • priceExVatdecimal

  • tagPricedecimal

  • duePaymentVatAmountValidboolean

Response body

{
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","name" : "string","policies" : "Active | CanCheckout | Closed | Deletable | Locked | OrderCreated | Owner | ReadOnly (Closed | Locked | OrderCreated | Rogue) | Rogue | ShopFrontAccess (Owner | Supervisor | Rogue) | Supervisor","billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"annotation" : {"comment" : "string","deliveryDate" : "dateTime"},"basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineCount" : "int32","itemCount" : "decimal","lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"shipments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"isCollectAtStore" : "boolean"}],"payments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"extPaymentMethodId" : "string","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"amountReserved" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"validationMessages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"duePaymentAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"duePaymentVatAmountValid" : "boolean"}}

Response codes

Http response Description
Returns the content of the basket.

Basket

DELETE/services/v3/baskets/{basketId}

Deletes the basket.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • basketIdint32REQUIRED

RESPONSE

Response codes

Http response Description
204 NoContent The delete succeeded.

Basket

PATCH/services/v3/baskets/{basketId}/annotation

Updates basket annotations such as name, comment or delivery date.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • basketIdint32REQUIRED

Parameters from Body

  • commentstring


    Sets an optional comment that is the customers remarks to the order.

  • basketNamestring


    Sets an an optional name for the basket, that help distinguish this basket in multi-basket scenarios.

  • deliveryDatedateTime


    Sets an optional (wish for) specific delivery time.

Request body

{
"comment" : "string",
"basketName" : "string",
"deliveryDate" : "dateTime"}

RESPONSE

Response codes

Http response Description
204 NoContent Indicates that the annotation was updated.

Basket

PUT/services/v3/baskets/{basketId}/annotation

Updates basket annotations such as name, comment or delivery date.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • basketIdint32REQUIRED

Parameters from Body

  • commentstring


    Sets an optional comment that is the customers remarks to the order.

  • basketNamestring


    Sets an an optional name for the basket, that help distinguish this basket in multi-basket scenarios.

  • deliveryDatedateTime


    Sets an optional (wish for) specific delivery time.

Request body

{
"comment" : "string",
"basketName" : "string",
"deliveryDate" : "dateTime"}

RESPONSE

Response codes

Http response Description
204 NoContent Indicates that the annotation was updated.

Basket

PUT/services/v3/baskets/{basketId}/billto

Currently not supported.

Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

REQUEST PARAMETERS

Parameters from Uri

  • basketIdint32REQUIRED

Parameters from Body

    Request body

    {}

    RESPONSE

    Response codes

    Http response Description
    401 Unauthorized Currently not supported.

    Basket

    POST/services/v3/baskets/{basketId}/checkout

    Turns the basket into an order.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • successURLstring


      Required when using .
      This is to where browser should be redirected when payment is successfully authorized.
      You may add "{orderGuid}" anywhere in the url where it will be replaced by the created orders Guid to be used in order API endpoints.

    • cancellationURLstring


      Required when using .
      This is to where browser should be redirected if payment is cancelled by user.

    • paymentFlowstringEnum


      Payment flow is used to adapt payment flow to different scenarios.

      Possible values:

      defaultheadless

    Request body

    {
"successURL" : "string",
"cancellationURL" : "string","paymentFlow" : "default | headless"}

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • paymentUrlHttpMethodrequestHttpMethod


      If using headless, this is the http method you should use to start a payment window session.

    • paymentUrlstring


      If using headless, this is the http url you should use to start a payment window session.

    • paymentUrlBodystring


      If using headless, this is the body you should submit (if the specified http method allows this) to start a payment window session.

    • paymentTransactionIdstring


      This is a transaction id from the payment system provider that may be used to interact directly with a payment provider, if the payment provider supports this.

    • orderIdint32


      The eSeller order id for the generated order for use in API

    • orderNumberstring


      The eSeller order number for the generated order for reference

    • orderGuidstring


      The eSeller order guid for the generated order for use in API

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"paymentUrlHttpMethod" : "requestHttpMethod","paymentUrl" : "string","paymentUrlBody" : "string","paymentTransactionId" : "string","orderId" : "int32","orderNumber" : "string","orderGuid" : "string"}}

    Response codes

    Http response Description
    200 OK The action succeeded.
    204 NoContent The action succeeded.

    Basket

    GET/services/v3/baskets/{basketId}/coupons

    Lists coupons in basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • codestring

    • namestring

    • typeOfValuestringEnum


      Determines the type of value delivered by a voucher.
      The majority of these values applies to coupons, as coupon is the primary implementation in eSeller.

      Possible values:

      discountPercentagefixedAmountfreeShippingbuyOneGetOnegiveAwayother

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"code" : "string","name" : "string","typeOfValue" : "discountPercentage | fixedAmount | freeShipping | buyOneGetOne | giveAway | other"}]}}

    Basket

    POST/services/v3/baskets/{basketId}/coupons

    Adds a coupon to basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • couponIdstring

    Request body

    {
"couponId" : "string"}

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Indicates the action succeeded.
    400 BadRequest Indicates that the coupon was not valid.

    Basket

    DELETE/services/v3/baskets/{basketId}/coupons

    Removes all coupons from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response codes

    Http response Description
    204 NoContent The delete succeeded.

    Basket

    DELETE/services/v3/baskets/{basketId}/coupons/{couponId}

    Removes a specific coupon from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    • couponIdstringREQUIRED

    RESPONSE

    Response codes

    Http response Description
    204 NoContent The delete succeeded.
    404 NotFound The specified coupon was not found in basket.

    Basket

    GET/services/v3/baskets/{basketId}/lines

    Gets basket lines.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Query

    • imagesizetypeids

      A comma-separated list of image size type IDs used for generating item images returned in the response. If this parameter is not set in the request, no item images are returned in the response.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • lineIdint32

    • tagstring

    • parentLineIdint32

    • itemKeyitemKey


      Unique identification of the item. This id is used in most api calls due to its uniqueness.
      The identity typically maps to an underlying database table.

      Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
      The kind of item is determined the the typeOfItem portion if this key.

    • itemIdint32

    • typeOfItemstringEnum

      Possible values:

      producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

    • itemSubTypestringEnum

      Possible values:

      standarddepositdiscount

    • internalItemId2int32

    • isLineEditableboolean

    • isLineDeleteableboolean

    • isLineCollapseboolean


      Gets a value indicating if any child lines should be initially collapsed.

    • isAmountVisibleboolean

    • isQuantityVisibleboolean

    • isAmountInTotalsboolean

    • externalItemId1string


      External (as opposed to internal) id of the item. This is the item number recognized in your ERP / warehouse system.

    • externalItemId2string

    • secondaryIdstring

    • eANstring

    • posIdstring


      In case of integrating with Point Of Sales system, the identification to that system may be listed here.

    • quantitydecimal

    • lineAmount


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • unitPrice


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • itemUrlstring

    • description1string

    • description2string

    • description3string

    • deliveryDatedateTime

    • priceCalculationDatedateTime

    • userCode1string

    • userCode2string

    • userCode3string

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"lineId" : "int32","tag" : "string","parentLineId" : "int32","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"itemSubType" : "standard | deposit | discount","internalItemId2" : "int32","isLineEditable" : "boolean","isLineDeleteable" : "boolean","isLineCollapse" : "boolean","isAmountVisible" : "boolean","isQuantityVisible" : "boolean","isAmountInTotals" : "boolean","externalItemId1" : "string","externalItemId2" : "string","secondaryId" : "string","eAN" : "string","posId" : "string","quantity" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"itemUrl" : "string","description1" : "string","description2" : "string","description3" : "string","deliveryDate" : "dateTime","priceCalculationDate" : "dateTime","userCode1" : "string","userCode2" : "string","userCode3" : "string"}]}}

    Basket

    POST/services/v3/baskets/{basketId}/lines

    Adds one or more items as lines to basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • itemKeyitemKey


      Gets or sets the id of product/variant/offer.
      Either ItemKey or ItemStringKey is required unless updating or deleting.

    • itemIdint32

    • typeOfItemstringEnum

      Possible values:

      producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

    • itemStringKeyitemStringKey


      Gets or sets the id of product/variant/offer.
      Either ItemKey or ItemStringKey is required unless updating or deleting.

    • itemIdstring

    • typeOfItemstringEnum

      Possible values:

      producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

    • createOptionstringEnum


      Line creation option. By default eSeller tries to add to an existing identical item in basket.

      Possible values:

      DefaultCreateNewLine

    • lineIdint32


      Gets or sets an id of the current line to be added.
      This id is ONLY used as an arbitrary id with a negative value, allowing you to refer to it when adding (new) child items in the same POST request.

    • parentLineIdint32


      Gets or sets the id of the parent basket line, either it is an existing line (positive number), or a new line to be added in this request (negative number).

    • quantitydecimal


      Gets or sets quantity of items.

    • deliveryDatedateTime


      Gets or sets a date when this particular item should be delivered. This participates in uniqueness of a basket line.

    • priceCalculationDateFollowsDeliveryDateboolean


      Gets or sets a value indicating what date to use to calculate prices.
      Note: Requires shop to allow setting price calculation date in API.

    • tagstring


      Gets or sets a tag to the line. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
      This participates in uniqueness of a basket line.

    • userCode1string


      String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
      This participates in uniqueness of a basket line.

    • userCode2string


      String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
      This participates in uniqueness of a basket line.

    • userCode3string


      String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
      This participates in uniqueness of a basket line.

    • description1string


      Gets or sets description. Only applicable if item is of type = "text"

    • description2string


      Gets or sets description. Only applicable if item is of type = "text"

    • description3string


      Gets or sets a third description. This field is not processed by eSeller, but carried forward to order, free to be use any purpose. This participates in uniqueness of a basket line.

    Request body

    [{
"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},
"itemStringKey" : {"itemId" : "string","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"createOption" : "Default | CreateNewLine",
"lineId" : "int32",
"parentLineId" : "int32",
"quantity" : "decimal",
"deliveryDate" : "dateTime",
"priceCalculationDateFollowsDeliveryDate" : "boolean",
"tag" : "string",
"userCode1" : "string",
"userCode2" : "string",
"userCode3" : "string",
"description1" : "string",
"description2" : "string",
"description3" : "string"}]

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}]}}

    Basket

    DELETE/services/v3/baskets/{basketId}/lines

    Deletes all lines from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}]}}

    Basket

    DELETE/services/v3/baskets/{basketId}/lines/{lineId}

    Deletes a specific line from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    • lineIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}]}}

    Basket

    GET/services/v3/baskets/{basketId}/paymentmethods

    Lists available payment methods for the basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • idint32

    • extPaymentMethodIdstring

    • isSelectedboolean

    • isApplePayboolean

    • namestring

    • descriptionstring

    • paymentSystemstring

    • paymentSystemIdint32

    • fee

    • paymentSystemCalculatesFeeboolean

    • currencySymbolstring

    • tagPricedecimal

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"id" : "int32","extPaymentMethodId" : "string","isSelected" : "boolean","isApplePay" : "boolean","name" : "string","description" : "string","paymentSystem" : "string","paymentSystemId" : "int32","fee" : {"paymentSystemCalculatesFee" : "boolean","currencySymbol" : "string","tagPrice" : "decimal"}}]}}

    Basket

    POST/services/v3/baskets/{basketId}/paymentmethods

    Set payment method to the basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • paymentMethodIdint32

    Request body

    {
"paymentMethodId" : "int32"}

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Set payment method to the basket.

    Basket

    GET/services/v3/baskets/{basketId}/progress

    Returns the progress of the basket on its way to becoming a fully accepted order. This returns a list of actions and their completeness required to check out the basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • actionstring

    • isCompletedboolean

    • references

    • referenceKindstring

    • referenceobject

    • requirements

    • actionstring

    • isCompletedboolean

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"action" : "string","isCompleted" : "boolean","references" : [{"referenceKind" : "string","reference" : "object"}],"requirements" : [{"action" : "string","isCompleted" : "boolean"}]}]}}

    Basket

    POST/services/v3/baskets/{basketId}/rollback

    Rollback a previously started checkout flow.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • paymentUrlHttpMethodrequestHttpMethod


      If using headless, this is the http method you should use to start a payment window session.

    • paymentUrlstring


      If using headless, this is the http url you should use to start a payment window session.

    • paymentUrlBodystring


      If using headless, this is the body you should submit (if the specified http method allows this) to start a payment window session.

    • paymentTransactionIdstring


      This is a transaction id from the payment system provider that may be used to interact directly with a payment provider, if the payment provider supports this.

    • orderIdint32


      The eSeller order id for the generated order for use in API

    • orderNumberstring


      The eSeller order number for the generated order for reference

    • orderGuidstring


      The eSeller order guid for the generated order for use in API

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"paymentUrlHttpMethod" : "requestHttpMethod","paymentUrl" : "string","paymentUrlBody" : "string","paymentTransactionId" : "string","orderId" : "int32","orderNumber" : "string","orderGuid" : "string"}]}}

    Response codes

    Http response Description
    204 NoContent The action succeeded.

    Basket

    PUT/services/v3/baskets/{basketId}/sellto

    Updates "sell-to" address of the basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • countryIdint32

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    Request body

    {
"companyName" : "string",
"attention" : "string",
"name" : "string",
"address" : "string",
"address2" : "string",
"zipCode" : "string",
"city" : "string",
"countryId" : "int32",
"email" : "string",
"reference" : "string",
"phoneNumber" : "string",
"mobilePhoneNumber" : "string",
"faxNumber" : "string",
"vATNumber" : "string",
"eInvoiceCustomerReference" : "string",
"eInvoiceCustomerExtDocNo" : "string",
"eInvoiceCustomerReceiverCode" : "string",
"eInvoiceCustomerIntPostingNo" : "string"}

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Indicates that sell-to address was updated.

    Basket

    PUT/services/v3/baskets/{basketId}/shipto

    Updates "ship-to" address of the basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • countryId


      Key identifying a single Country

    • countryIDint32

    • redisCacheTtlMinutesint32

    Request body

    {
"companyName" : "string",
"attention" : "string",
"name" : "string",
"address" : "string",
"address2" : "string",
"zipCode" : "string",
"city" : "string",
"countryId" : {"countryID" : "int32","redisCacheTtlMinutes" : "int32"}}

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Indicates that ship-to address was updated.

    Basket

    GET/services/v3/baskets/{basketId}/state

    Gets the state held by the basket. Basket records state information as this is a vital informatio that directly affects product availability and pricing. Unlike many other resources, the basket information is processed based on the state of the basket, and not based on the context provided by the clients state. You should therefore take care to sync these states between client and basket and / or otherwise make any differences in state obvious to end users in a way that forms a natural flow for end users. The response format is the same as the context api. The context helps you identify any discrepancies of the current client-held context.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    Returns state headers.

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    • include=description

      BillToAddress is not rendered, unless this condition is specified.
      SellToAddress is not rendered, unless this condition is specified.
      ShipToAddress is not rendered, unless this condition is specified.
      Annotations are not rendered, unless this condition is specified.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data


      Main properties of a basket.

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • idint32


      basket Id

    • basketGuidguid


      Gets or sets Guid of basket.

    • dateModifieddateTime


      Date of last modification in UTC

    • namestring


      Gets or sets the name of the basket.

    • policiesbasketPoliciesEnum


      Gets the policies applied to the basket in the current context.

      Possible values:

      ActiveCanCheckoutClosedDeletableLockedOrderCreatedOwnerReadOnly (Closed | Locked | OrderCreated | Rogue)RogueShopFrontAccess (Owner | Supervisor | Rogue)Supervisor

    • billToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • sellToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • shipToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • annotation

    • commentstring

    • deliveryDatedateTime

    • basketTotal


      Gets the total amount for this basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • lineCountint32


      How many lines in basket

    • itemCountdecimal


      How many items in basket, i.e. a sum of all quantities.

    • lineTotal


      Gets the total amount for items in basket. This excludes any fees applicable.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • shipments


      Gets a list of shipments applicable to the basket, including fees.

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • isCollectAtStoreboolean

    • payments


      Gets a list of payments applicable to the basket, including fees.

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • extPaymentMethodIdstring

    • namestring

    • descriptionstring

    • fee


      Aplicable fee, added to the total value of basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • amountReserved


      Any amount already reserved for payment. Amount due is totalvalue minus sum(AmountReserved)

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • validationMessages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • location


      Gets location to Basket

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • locationIdint64


      The ID of the location.
      May be used to fetch a specific location.

    • extLocationIdstring


      Location ext. ID.

    • posIdstring


      Only relevant to locations integrated with an external POS system.

    • isDefaultboolean


      Defines whether the location is default for the current shop.

    • isBuyableboolean


      Defines whether items may be ordered from this location.

    • showAddToBasketboolean


      Defines wheter "add to basket" buttons should be visible for this location.

    • uiSortorderint32


      Sort order value that may be used to order a list of locations according to this value.

    • locationNamestring


      The name of the location.

    • isVisibleInShopboolean


      Defines whether the location should be shown in the shop.
      This flag does no no influence wether this location can be used to sell from.

    • namestring


      Location address name.

    • name2string


      Location address name2.

    • addressstring


      Location Address.

    • address2string


      Location Address2.

    • citystring


      Location address city.

    • postCodestring


      Location address post code.

    • countystring


      Location address county.

    • countryIdint32


      Location address country.

    • emailAddressstring


      Location e-mail address. May receive a copy of order confirmation e-mails.

    • contactstring


      Location contact.

    • phoneNumberstring


      Location phone number.

    • faxNumberstring


      Location fax number.

    • leadTimetimespan


      Location lead time.
      An off-set in hours from the order is placed to when it may be collected at a physical location.

    • openingHours


      Returns any opening hours defined for the location.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • specialOpeningHours


      Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • collectTimesdateTime


      Returns any collect times for the context of the request.
      Setting the "timescope" and "interval" query parameters in the request influences what is returned.

    • duePaymentAmount


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • duePaymentVatAmountValidboolean

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","name" : "string","policies" : "Active | CanCheckout | Closed | Deletable | Locked | OrderCreated | Owner | ReadOnly (Closed | Locked | OrderCreated | Rogue) | Rogue | ShopFrontAccess (Owner | Supervisor | Rogue) | Supervisor","billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"annotation" : {"comment" : "string","deliveryDate" : "dateTime"},"basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineCount" : "int32","itemCount" : "decimal","lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"shipments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"isCollectAtStore" : "boolean"}],"payments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"extPaymentMethodId" : "string","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"amountReserved" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"validationMessages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"duePaymentAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"duePaymentVatAmountValid" : "boolean"}}

    Response codes

    Http response Description
    Returns the state held by the basket.

    Basket

    PUT/services/v3/baskets/{basketId}/state

    Updates basket context such as location, currency and language.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • locationKeyint64

    • currencyKeyint32

    • languageKeyint32

    • isActiveboolean

    Request body

    {
"locationKey" : "int64",
"currencyKey" : "int32",
"languageKey" : "int32",
"isActive" : "boolean"}

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Indicates that context was updated.

    Basket

    GET/services/v3/baskets/{basketId}/status

    OBSOLETED ENDPOINT! Do not use this endpoint - use /progress endpoint instead. This endpoint will be removed any time soon.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Basket

    GET/services/v3/baskets/{basketId}/uservalues

    Gets all user values from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    • contentTransferEncodingstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","contentTransferEncoding" : "string"}]}}

    Basket

    POST/services/v3/baskets/{basketId}/uservalues

    Creates or updates user values.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    Request body

    [{
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string"}]

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Indicates that uservalue was created or updated.

    Basket

    PUT/services/v3/baskets/{basketId}/uservalues

    Creates or updates user values.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    Parameters from Body

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    Request body

    [{
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string"}]

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Indicates that uservalue was created or updated.

    Basket

    DELETE/services/v3/baskets/{basketId}/uservalues

    Deletes all user values from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    RESPONSE

    Response codes

    Http response Description
    204 NoContent The delete succeeded.

    Basket

    GET/services/v3/baskets/{basketId}/uservalues/{key}

    Gets a specific user value by specified key from basket. If checksum is supplied, the user value is streamed in the response instead of in json output.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    • keystringREQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    • contentTransferEncodingstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","contentTransferEncoding" : "string"}}

    Basket

    DELETE/services/v3/baskets/{basketId}/uservalues/{key}

    Deletes a user value by specified key from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    • keystringREQUIRED

    RESPONSE

    Response codes

    Http response Description
    204 NoContent The delete succeeded.

    Basket

    PUT/services/v3/baskets/{basketId}/uservalues/{key}

    Updates a user value by specified key from basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • basketIdint32REQUIRED

    • keystringREQUIRED

    Parameters from Body

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    Request body

    {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string"}

    RESPONSE

    Response codes

    Http response Description
    204 NoContent Indicates that uservalue was updated.

    Basket

    POST/services/v3/baskets/{id}/merge

    Merges data from another basket into this basket. Basically, this imports lines, coupons and redeemed giftcards into this basket.

    Authentication header is required with one of the following roles: Visitor, Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • idint32REQUIRED

    Parameters from Body

    • fromBasketIdint32

    • mergeTostringEnum

      Possible values:

      this

    Request body

    {
"fromBasketId" : "int32","mergeTo" : "this"}

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}]}

    Basket

    PUT/services/v3/baskets/{id}/takeownership

    Takes ownership of a "rogue" basket. If a basket has policy rogue, you can take ownership of it, and thereby re-gain full control of it. A rogue basket is a basket that was created prior to logging in and subsequently transferred to the login by authenticating as a non-anonymous user.

    Authentication header is required with one of the following roles: Customer

    REQUEST PARAMETERS

    Parameters from Uri

    • idint32REQUIRED

    RESPONSE

    Response codes

    Http response Description
    204 NoContent The update succeeded.

    Basket

    GET/sessionservices/v2/basket

    Gets visible basket or baskets, depending on shop allows multiple basket

    Authentication header is not allowed.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • ageVerification

    • noncestring

    • statusstringEnum

      Possible values:

      noneprocessingsuccessfailed

    • tokenIdstring

    • idBrokerDKAgeVerifiedstring

    • idint32


      basket ID

    • basketGuidguid


      Gets or sets Guid of basket.

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    • basketTotal


      Gets the total amount for this basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • lineTotal


      Gets the total amount for items in basket. This excludes any fees applicable.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • fees


      Gets an array of fees applicable to this basket.

    • typeOfFeestringEnum

      Possible values:

      shipmentpayment

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • giftCards


      Gets an array of fees applicable to this basket.

    • totalRedemedAmountdecimal

    • totalRedemedVatAmountdecimal

    • items

    • displayNamestring

    • giftCardPurposestring

    • referencingCurrencySymbolstring

    • balanceAmountdecimal

    • balanceVatAmountdecimal

    • reservedAmountdecimal

    • reservedVatAmountdecimal

    • remaingAmountdecimal

    • remaingVatAmountdecimal

    • duePaymentAmountobject


      Due payment to complete total payment.

    • duePaymentVatAmountValidboolean

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"ageVerification" : {"nonce" : "string","status" : "none | processing | success | failed","tokenId" : "string","idBrokerDKAgeVerified" : "string"},"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","isCollectAtStore" : "boolean","name" : "string","basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"fees" : [{"typeOfFee" : "shipment | payment","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"giftCards" : {"totalRedemedAmount" : "decimal","totalRedemedVatAmount" : "decimal","items" : [{"displayName" : "string","giftCardPurpose" : "string","referencingCurrencySymbol" : "string","balanceAmount" : "decimal","balanceVatAmount" : "decimal","reservedAmount" : "decimal","reservedVatAmount" : "decimal","remaingAmount" : "decimal","remaingVatAmount" : "decimal"}]},"duePaymentAmount" : "object","duePaymentVatAmountValid" : "boolean"}]}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    POST/sessionservices/v2/basket

    Creates a new basket. Note: This will advertently create a session.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Body

    • idint32


      basket ID

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    Request body

    {
"id" : "int32",
"dateModified" : "dateTime",
"isCollectAtStore" : "boolean",
"name" : "string"}

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data


      Basket

    • ageVerification

    • noncestring

    • statusstringEnum

      Possible values:

      noneprocessingsuccessfailed

    • tokenIdstring

    • idBrokerDKAgeVerifiedstring

    • idint32


      basket ID

    • basketGuidguid


      Gets or sets Guid of basket.

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    • basketTotal


      Gets the total amount for this basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • lineTotal


      Gets the total amount for items in basket. This excludes any fees applicable.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • fees


      Gets an array of fees applicable to this basket.

    • typeOfFeestringEnum

      Possible values:

      shipmentpayment

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • giftCards


      Gets an array of fees applicable to this basket.

    • totalRedemedAmountdecimal

    • totalRedemedVatAmountdecimal

    • items

    • displayNamestring

    • giftCardPurposestring

    • referencingCurrencySymbolstring

    • balanceAmountdecimal

    • balanceVatAmountdecimal

    • reservedAmountdecimal

    • reservedVatAmountdecimal

    • remaingAmountdecimal

    • remaingVatAmountdecimal

    • duePaymentAmountobject


      Due payment to complete total payment.

    • duePaymentVatAmountValidboolean

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"ageVerification" : {"nonce" : "string","status" : "none | processing | success | failed","tokenId" : "string","idBrokerDKAgeVerified" : "string"},"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","isCollectAtStore" : "boolean","name" : "string","basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"fees" : [{"typeOfFee" : "shipment | payment","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"giftCards" : {"totalRedemedAmount" : "decimal","totalRedemedVatAmount" : "decimal","items" : [{"displayName" : "string","giftCardPurpose" : "string","referencingCurrencySymbol" : "string","balanceAmount" : "decimal","balanceVatAmount" : "decimal","reservedAmount" : "decimal","reservedVatAmount" : "decimal","remaingAmount" : "decimal","remaingVatAmount" : "decimal"}]},"duePaymentAmount" : "object","duePaymentVatAmountValid" : "boolean"}}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    GET/sessionservices/v2/basket/{id}

    Gets the basket with the specified ID. If this basket does not exist, or you do not have permissions, a 404 is returned.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Uri

    • idint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data


      Basket

    • ageVerification

    • noncestring

    • statusstringEnum

      Possible values:

      noneprocessingsuccessfailed

    • tokenIdstring

    • idBrokerDKAgeVerifiedstring

    • idint32


      basket ID

    • basketGuidguid


      Gets or sets Guid of basket.

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    • basketTotal


      Gets the total amount for this basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • lineTotal


      Gets the total amount for items in basket. This excludes any fees applicable.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • fees


      Gets an array of fees applicable to this basket.

    • typeOfFeestringEnum

      Possible values:

      shipmentpayment

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • giftCards


      Gets an array of fees applicable to this basket.

    • totalRedemedAmountdecimal

    • totalRedemedVatAmountdecimal

    • items

    • displayNamestring

    • giftCardPurposestring

    • referencingCurrencySymbolstring

    • balanceAmountdecimal

    • balanceVatAmountdecimal

    • reservedAmountdecimal

    • reservedVatAmountdecimal

    • remaingAmountdecimal

    • remaingVatAmountdecimal

    • duePaymentAmountobject


      Due payment to complete total payment.

    • duePaymentVatAmountValidboolean

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"ageVerification" : {"nonce" : "string","status" : "none | processing | success | failed","tokenId" : "string","idBrokerDKAgeVerified" : "string"},"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","isCollectAtStore" : "boolean","name" : "string","basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"fees" : [{"typeOfFee" : "shipment | payment","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"giftCards" : {"totalRedemedAmount" : "decimal","totalRedemedVatAmount" : "decimal","items" : [{"displayName" : "string","giftCardPurpose" : "string","referencingCurrencySymbol" : "string","balanceAmount" : "decimal","balanceVatAmount" : "decimal","reservedAmount" : "decimal","reservedVatAmount" : "decimal","remaingAmount" : "decimal","remaingVatAmount" : "decimal"}]},"duePaymentAmount" : "object","duePaymentVatAmountValid" : "boolean"}}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    GET/sessionservices/v2/basket/current

    Gets current basket. If a shop allows multiple baskets, the method returns active basket.

    Authentication header is not allowed.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data


      Basket

    • ageVerification

    • noncestring

    • statusstringEnum

      Possible values:

      noneprocessingsuccessfailed

    • tokenIdstring

    • idBrokerDKAgeVerifiedstring

    • idint32


      basket ID

    • basketGuidguid


      Gets or sets Guid of basket.

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    • basketTotal


      Gets the total amount for this basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • lineTotal


      Gets the total amount for items in basket. This excludes any fees applicable.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • fees


      Gets an array of fees applicable to this basket.

    • typeOfFeestringEnum

      Possible values:

      shipmentpayment

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • giftCards


      Gets an array of fees applicable to this basket.

    • totalRedemedAmountdecimal

    • totalRedemedVatAmountdecimal

    • items

    • displayNamestring

    • giftCardPurposestring

    • referencingCurrencySymbolstring

    • balanceAmountdecimal

    • balanceVatAmountdecimal

    • reservedAmountdecimal

    • reservedVatAmountdecimal

    • remaingAmountdecimal

    • remaingVatAmountdecimal

    • duePaymentAmountobject


      Due payment to complete total payment.

    • duePaymentVatAmountValidboolean

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"ageVerification" : {"nonce" : "string","status" : "none | processing | success | failed","tokenId" : "string","idBrokerDKAgeVerified" : "string"},"id" : "int32","basketGuid" : "guid","dateModified" : "dateTime","isCollectAtStore" : "boolean","name" : "string","basketTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"fees" : [{"typeOfFee" : "shipment | payment","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"giftCards" : {"totalRedemedAmount" : "decimal","totalRedemedVatAmount" : "decimal","items" : [{"displayName" : "string","giftCardPurpose" : "string","referencingCurrencySymbol" : "string","balanceAmount" : "decimal","balanceVatAmount" : "decimal","reservedAmount" : "decimal","reservedVatAmount" : "decimal","remaingAmount" : "decimal","remaingVatAmount" : "decimal"}]},"duePaymentAmount" : "object","duePaymentVatAmountValid" : "boolean"}}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    GET/sessionservices/v2/basket/current/coupon

    List coupons in basket.

    Authentication header is not allowed.

    RESPONSE

    Response fields

    • coupons

    • codestring

    • typeOfValuestringEnum


      Determines the type of value delivered by a voucher.
      The majority of these values applies to coupons, as coupon is the primary implementation in eSeller.

      Possible values:

      discountPercentagefixedAmountfreeShippingbuyOneGetOnegiveAwayother

    • namestring

    Response body

    {
"coupons" : [{"code" : "string","typeOfValue" : "discountPercentage | fixedAmount | freeShipping | buyOneGetOne | giveAway | other","name" : "string"}]}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    POST/sessionservices/v2/basket/current/coupon

    Adds the coupon to basket and returns a message wether or not it succeeded. A failure adding (if not found, duplicate, already exists etc) will result in a code 400.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Body

    • couponIdstring

    Request body

    {
"couponId" : "string"}

    RESPONSE

    Response fields

    • coupons

    • codestring

    • typeOfValuestringEnum


      Determines the type of value delivered by a voucher.
      The majority of these values applies to coupons, as coupon is the primary implementation in eSeller.

      Possible values:

      discountPercentagefixedAmountfreeShippingbuyOneGetOnegiveAwayother

    • namestring

    Response body

    {
"coupons" : [{"code" : "string","typeOfValue" : "discountPercentage | fixedAmount | freeShipping | buyOneGetOne | giveAway | other","name" : "string"}]}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    DELETE/sessionservices/v2/basket/current/coupon

    Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400.

    Authentication header is not allowed.

    RESPONSE

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    DELETE/sessionservices/v2/basket/current/coupon/{couponId}

    Removes the coupon from basket and returns a message wether or not it succeeded. A failure removing if not found will result in a code 400.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Uri

    • couponIdstringREQUIRED

    RESPONSE

    Response fields

    • coupons

    • codestring

    • typeOfValuestringEnum


      Determines the type of value delivered by a voucher.
      The majority of these values applies to coupons, as coupon is the primary implementation in eSeller.

      Possible values:

      discountPercentagefixedAmountfreeShippingbuyOneGetOnegiveAwayother

    • namestring

    Response body

    {
"coupons" : [{"code" : "string","typeOfValue" : "discountPercentage | fixedAmount | freeShipping | buyOneGetOne | giveAway | other","name" : "string"}]}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    GET/sessionservices/v1/basket

    Gets visible basket or baskets, depending on shop allows multiple basket

    Authentication header is not allowed.

    RESPONSE

    Response fields

    • idint32


      basket ID

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    Response body

    {
"id" : "int32",
"dateModified" : "dateTime",
"isCollectAtStore" : "boolean",
"name" : "string"}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    GET/sessionservices/v1/basket/{id}

    Gets the basket with the specified ID. If this basket does not exist, or you do not have permissions, a 404 is returned.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Uri

    • idint32REQUIRED

    RESPONSE

    Response fields

    • idint32


      basket ID

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    Response body

    {
"id" : "int32",
"dateModified" : "dateTime",
"isCollectAtStore" : "boolean",
"name" : "string"}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Basket

    GET/sessionservices/v1/basket/current

    Gets current basket. If a shop allows multiple baskets, the method returns active basket.

    Authentication header is not allowed.

    RESPONSE

    Response fields

    • idint32


      basket ID

    • dateModifieddateTime


      Date of last modification in UTC

    • isCollectAtStoreboolean


      Special property indicating if the basket contents is beeing picked up by customer (true) or to be shipped by a carrier.

    • namestring


      Gets or sets the name of the basket.

    Response body

    {
"id" : "int32",
"dateModified" : "dateTime",
"isCollectAtStore" : "boolean",
"name" : "string"}

    Response codes

    Http response Description
    200 OK Everything is fine
    400 BadRequest The request was not understood
    404 NotFound There is no basket context

    Text

    GET/services/v3/texts

    Return a list of text blocks

    Authentication header is not allowed.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • idstring

    • contentstring

    • typestringEnum


      Represents The type of text returned by the response

      Possible values:

      paragraphjsonConverter

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "string","content" : "string","type" : "paragraph | jsonConverter"}]}}

    Recommendations

    GET/services/v3/recommendations?itemKeys={itemKeys}

    Returns product recommendations based on the a provided JSON formatted array of item keys, f.inst [{"itemId":6536309,"typeOfItem":"product"}], and other parameters. Item keys that do not have the type "product" will be ignored.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Uri

    • itemKeysstringREQUIRED

    • include=shortdesc

      Causes item short description to be rendered

    • include=shortdescrecurse

      same as shortdesc, but also renders item short description for child items in f.inst bom products.

    • include=longdesc

      Causes item long description to be rendered

    • include=longdescrecurse

      same as longdesc, but also renders item long description for child items in f.inst bom products.

    • include=seo

      SeoMetaTagKeywords is rendered
      SeoHtmlTitle is rendered
      SeoMetaTagDescription is rendered

    • include=inventory

      Show exact inventory

    • include=locations

      show the product locations

    Parameters from Query

    • timeScopeGt

      Allows limiting the dataset to a specific date range ("greater than"). For example, a value of "now-2y" means that recommendations based on orders created within the last two years will be included in the result. Range is exclusive. If not specified, the default value is "now-30d". Supports Elasticsearch date-math.

    • timeScopeLt

      Allows limiting the dataset to a specific date range ("lower than"). For example, a value of "now-30d" means that recommendations based on orders created earlier than 30 days ago will be included in the result. Range is exclusive. If not specified, the time scope is open ended. Supports Elasticsearch date-math.

    • q

      Elasticsearch URI query string that may be used to define additional filters. It is possible to limit the recommendations to be based on orders from specific countries using "customercountryid". "customercountryid" is the country of the order and must be specified as the eSeller country ID, for instance 11 for Denmark. Example: q=customercountryid:(11 OR 41). Supports filtering by any user value on orders. User value fields may be queried using the syntaxt "uv_{acccountid}_{uservaluekey}". User value keys are transformed to lowercase.Example: q=uv_306_customergender:female.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • variantDimensions

    • namestring

    • values

    • isInItemsboolean

    • namestring

    • indexint32

    • filterFields

    • kindstringEnum

      Possible values:

      productPropertycustomFieldvariantproductPrice

    • filterFieldIdint64

    • extFilterFieldIdstring

    • namestring

    • typestringEnum

      Possible values:

      customstringintegerdecimal

    • isAppliedboolean

    • upperBounddecimal


      If field is a number type, marks the upper bound value for items in the result.

    • lowerBounddecimal


      If field is a number type, marks the lower bound value for items in the result.

    • upperGrossBounddecimal


      If field is a number type, marks the upper bound value for items in the un-filtered result.

    • lowerGrossBounddecimal


      If field is a number type, marks the lower bound value for items in the un-filtered result.

    • values

    • nativeValuestring

    • valuestring

    • countint32


      How many items within the result has this value.

    • isAppliedboolean

    • sortOrderint32

    • productMenus

    • scoresingle

    • navigateUrlstring

    • navigateTextstring

    • navigateTargetstring

    • extMenuItemIdstring

    • menuItemIdint32

    • descriptionstring

    • alternateDescriptionstring

    • uiSortOrderint32

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • articles

    • scoresingle

    • navigateUrlstring

    • navigateTextstring

    • navigateTargetstring

    • uiSortOrderint32

    • descriptionstring

    • metaData


      Meta data and settings for rendering this list.

    • showProductIdboolean

    • showProductEanboolean

    • showProductManufacturerSkuboolean

    • showExtProductIdboolean

    • showAltExtProductIdboolean

    • enableAddToBasketboolean

    • unitOfMeasures

    • unitOfMeasureIdint32

    • extUnitOfMeasureIdstring

    • abbreviationstring


      Short notation of the unit. Try using abbreviations familiar to your clients.

    • siUnitstringEnum


      Indicates if the unit is a standardized unit (f.inst kilo) or non-standardized unit (f.inst box or pallet)

      Lists the 7 fundamental unit of measures based on the International System of Units (SI). See https://en.wikipedia.org/wiki/SI_base_unit .
      An additional 8th unit ia added to describe abstract business specific units, like "each" or "box", that does not translate very well to an SI unit.
      This enumeration is used to describe physical and/or logistical aspects of an .

      Possible values:

      nonSiUnitlengthmasstimeelectricCurrentthermoDynamicTemperatureamountOfSubstanceluminousIntensity

    • conversionFactordecimal


      Indicates how this unit mathematical relates to its base unit.
      Base units will have conversion factor 1.

    • baseUnitOfMeasureIdint32


      If this unit relates to another unit. All units with the same base can be converted between each other.

    • descriptionstring


      A more elaborate description of this unit. Try using terms familiar to your clients.

    • items

    • itemVersionstring

    • extVariantIdstring

    • extItemIdstring

    • itemKeyitemKey


      Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
      The kind of item is determined the the typeOfItem portion if this key.

    • itemIdint32

    • typeOfItemstringEnum

      Possible values:

      producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

    • namestring

    • shortDescriptionstring

    • longDescriptionstring

    • seoMetaTagKeywordsstring

    • seoHtmlTitlestring

    • seoMetaTagDescriptionstring

    • scoredouble

    • variantNamestring

    • variantValuesstring

    • hasVariantsboolean

    • hasSalesPriceboolean

    • showSalesPriceboolean

    • frontPageProductboolean

    • greatBuyboolean

    • noveltyProductboolean

    • deprecatedboolean

    • manufacturerIdint32

    • manufacturerstring

    • manufacturerSkustring

    • hasExpectedDeliveryDateboolean

    • expectedDeliveryDatedateTime

    • shipmentsstring

    • isBuyableboolean

    • isConfiguredProductboolean

    • showAddToBasketboolean

    • showAddToFavoritesboolean

    • boundToInventoryCountboolean

    • stocklevelint32

    • locations

    • locationIdint64

    • extLocationIdstring

    • isBuyableboolean

    • isVisibleInShopboolean

    • stocklevelint32

    • boundToInventoryCountboolean

    • stockAvailabilitystring

    • grossWeight


      Shows an amount in a specific unit with reference to the unit specification.

    • amountdecimal

    • unitOfMeasureIdint32

    • abbreviationstring

    • salesUnit

    • unitOfMeasureIdint32

    • abbreviationstring

    • salesUnitConstraints

    • extSalesUnitConstraintIdstring

    • smallestCountdecimal


      Indicates least common multiple in which that this item can be bought. Quantity bought must be a multiple of this value.
      F.inst if your unit is kilo, 1 indicates you buy in chunks of kilos, 0.5 indicates you buy in chunks of half-kilos (note: scale would then be 1 to allow for a decimal)

    • minimumCountdecimal


      Indicates the minimum number of units clients are required to buy.

    • maximumCountdecimal

    • scaleint32


      Indicates how many decimal places should be shown and accepted for the related unit. this would typically be 1 (one) if buying in chunks of whole units.

    • stockAvailabilitystring

    • salesPrices

    • amount


      Shows an amount in a specific unit with reference to the unit specification.

    • amountdecimal

    • unitOfMeasureIdint32

    • abbreviationstring

    • beforePrice


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • recommendedPrice


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • salesPrice


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • totalSalesPrice


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • descriptionstring

    • discountLabelstring

    • salesPriceLabelstring

    • validFromdateTime


      Date and time in UTC, from when this price takes effect.

    • validTodateTime


      Date and time in UTC when this price is no longer valid.

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • customFields

    • customFieldIdint64

    • extCustomFieldIdstring

    • valuestring

    • namestring

    • nativeValuestring

    • variants

    • itemKeyitemKey


      Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
      The kind of item is determined the the typeOfItem portion if this key.

    • itemIdint32

    • typeOfItemstringEnum

      Possible values:

      producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

    • suggestedQuantitydecimal

    • eanstring

    • annotationobject

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"id" : "string","apiVersion" : "string","context" : "string","servedBy" : "string","timeServed" : "string","appVersion" : "string","took" : "double","data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","variantDimensions" : [{"name" : "string","values" : [{"isInItems" : "boolean","name" : "string"}],"index" : "int32"}],"filterFields" : [{"kind" : "productProperty | customField | variant | productPrice","filterFieldId" : "int64","extFilterFieldId" : "string","name" : "string","type" : "custom | string | integer | decimal","isApplied" : "boolean","upperBound" : "decimal","lowerBound" : "decimal","upperGrossBound" : "decimal","lowerGrossBound" : "decimal","values" : [{"nativeValue" : "string","value" : "string","count" : "int32","isApplied" : "boolean","sortOrder" : "int32"}]}],"productMenus" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","extMenuItemId" : "string","menuItemId" : "int32","description" : "string","alternateDescription" : "string","uiSortOrder" : "int32","links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}]}],"articles" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","uiSortOrder" : "int32","description" : "string"}],"metaData" : {"showProductId" : "boolean","showProductEan" : "boolean","showProductManufacturerSku" : "boolean","showExtProductId" : "boolean","showAltExtProductId" : "boolean","enableAddToBasket" : "boolean"},"unitOfMeasures" : [{"unitOfMeasureId" : "int32","extUnitOfMeasureId" : "string","abbreviation" : "string","siUnit" : "nonSiUnit | length | mass | time | electricCurrent | thermoDynamicTemperature | amountOfSubstance | luminousIntensity","conversionFactor" : "decimal","baseUnitOfMeasureId" : "int32","description" : "string"}],"items" : [{"itemVersion" : "string","extVariantId" : "string","extItemId" : "string","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"name" : "string","shortDescription" : "string","longDescription" : "string","seoMetaTagKeywords" : "string","seoHtmlTitle" : "string","seoMetaTagDescription" : "string","score" : "double","variantName" : "string","variantValues" : "string","hasVariants" : "boolean","hasSalesPrice" : "boolean","showSalesPrice" : "boolean","frontPageProduct" : "boolean","greatBuy" : "boolean","noveltyProduct" : "boolean","deprecated" : "boolean","manufacturerId" : "int32","manufacturer" : "string","manufacturerSku" : "string","hasExpectedDeliveryDate" : "boolean","expectedDeliveryDate" : "dateTime","shipments" : "string","isBuyable" : "boolean","isConfiguredProduct" : "boolean","showAddToBasket" : "boolean","showAddToFavorites" : "boolean","boundToInventoryCount" : "boolean","stocklevel" : "int32","locations" : [{"locationId" : "int64","extLocationId" : "string","isBuyable" : "boolean","isVisibleInShop" : "boolean","stocklevel" : "int32","boundToInventoryCount" : "boolean","stockAvailability" : "string"}],"grossWeight" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"salesUnit" : [{"unitOfMeasureId" : "int32","abbreviation" : "string"}],"salesUnitConstraints" : [{"extSalesUnitConstraintId" : "string","smallestCount" : "decimal","minimumCount" : "decimal","maximumCount" : "decimal","scale" : "int32"}],"stockAvailability" : "string","salesPrices" : [{"amount" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"beforePrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"recommendedPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"salesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"totalSalesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"description" : "string","discountLabel" : "string","salesPriceLabel" : "string","validFrom" : "dateTime","validTo" : "dateTime"}],"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customFields" : [{"customFieldId" : "int64","extCustomFieldId" : "string","value" : "string","name" : "string","nativeValue" : "string"}],"variants" : [{"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"}}],"suggestedQuantity" : "decimal","ean" : "string","annotation" : "object"}]}}]}}

    Order

    GET/services/v3/orders/{orderGuid}

    Gets a specific order and its content by its id.

    Authentication header is not allowed.

    Returns state headers.

    REQUEST PARAMETERS

    Parameters from Uri

    • orderGuidguidREQUIRED

    • include=description

      SellToAddress is not rendered, unless this condition is specified.
      ShipToAddress is not rendered, unless this condition is specified.
      Annotations are not rendered, unless this condition is specified.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data


      Main properties of a basket.

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • idint32

    • orderGuidguid

    • orderNumberstring

    • orderStatestringEnum

      Possible values:

      creatednewOrdercancelledinProcessbackordershipped

    • lineCountint32

    • itemCountdecimal

    • lineTotal


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • orderTotal


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • dateFinalizeddateTime

    • policiesorderPoliciesEnum

      Possible values:

      ShopFrontAccess

    • sellToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • shipToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • annotation

    • commentstring

    • deliveryDatedateTime

    • shipments

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • isCollectAtStoreboolean

    • payments

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • extPaymentMethodIdstring

    • namestring

    • descriptionstring

    • fee


      Aplicable fee, added to the total value of basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • amountReserved


      Any amount already reserved for payment. Amount due is totalvalue minus sum(AmountReserved)

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • billToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • location

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • locationIdint64


      The ID of the location.
      May be used to fetch a specific location.

    • extLocationIdstring


      Location ext. ID.

    • posIdstring


      Only relevant to locations integrated with an external POS system.

    • isDefaultboolean


      Defines whether the location is default for the current shop.

    • isBuyableboolean


      Defines whether items may be ordered from this location.

    • showAddToBasketboolean


      Defines wheter "add to basket" buttons should be visible for this location.

    • uiSortorderint32


      Sort order value that may be used to order a list of locations according to this value.

    • locationNamestring


      The name of the location.

    • isVisibleInShopboolean


      Defines whether the location should be shown in the shop.
      This flag does no no influence wether this location can be used to sell from.

    • namestring


      Location address name.

    • name2string


      Location address name2.

    • addressstring


      Location Address.

    • address2string


      Location Address2.

    • citystring


      Location address city.

    • postCodestring


      Location address post code.

    • countystring


      Location address county.

    • countryIdint32


      Location address country.

    • emailAddressstring


      Location e-mail address. May receive a copy of order confirmation e-mails.

    • contactstring


      Location contact.

    • phoneNumberstring


      Location phone number.

    • faxNumberstring


      Location fax number.

    • leadTimetimespan


      Location lead time.
      An off-set in hours from the order is placed to when it may be collected at a physical location.

    • openingHours


      Returns any opening hours defined for the location.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • specialOpeningHours


      Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • collectTimesdateTime


      Returns any collect times for the context of the request.
      Setting the "timescope" and "interval" query parameters in the request influences what is returned.

    • currency

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • currencyIdint32

    • extCurrencyIdstring

    • displayNamestring

    • uISortOrderint32

    • namestring

    • iso4217Alpha3string

    • iso4217Numericint32

    • decimalSeparatorstring

    • decimalDigitsint32

    • decimalGroupSeparatorstring

    • groupSizeint32

    • positivePatternint32

    • negativePatternint32

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","orderGuid" : "guid","orderNumber" : "string","orderState" : "created | newOrder | cancelled | inProcess | backorder | shipped","lineCount" : "int32","itemCount" : "decimal","lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"orderTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"dateFinalized" : "dateTime","policies" : "ShopFrontAccess","sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"annotation" : {"comment" : "string","deliveryDate" : "dateTime"},"shipments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"isCollectAtStore" : "boolean"}],"payments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"extPaymentMethodId" : "string","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"amountReserved" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"}}}

    Response codes

    Http response Description
    Returns the content of the order.

    Order

    GET/services/v3/orders/{orderGuid}/lines

    Gets order lines.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Uri

    • orderGuidguidREQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • lineIdint32

    • itemKeyitemKey


      Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
      The kind of item is determined the the typeOfItem portion if this key.

    • itemIdint32

    • typeOfItemstringEnum

      Possible values:

      producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

    • itemSubTypestringEnum

      Possible values:

      standarddepositdiscount

    • isAmountVisibleboolean

    • isQuantityVisibleboolean

    • isAmountInTotalsboolean

    • externalItemId1string

    • externalItemId2string

    • secondaryIdstring

    • eANstring

    • quantitydecimal

    • lineAmount


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • unitPrice


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • itemUrlstring

    • description1string

    • description2string

    • description3string

    • userCode1string

    • userCode2string

    • userCode3string

    • tagstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"lineId" : "int32","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"itemSubType" : "standard | deposit | discount","isAmountVisible" : "boolean","isQuantityVisible" : "boolean","isAmountInTotals" : "boolean","externalItemId1" : "string","externalItemId2" : "string","secondaryId" : "string","eAN" : "string","quantity" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"itemUrl" : "string","description1" : "string","description2" : "string","description3" : "string","userCode1" : "string","userCode2" : "string","userCode3" : "string","tag" : "string"}]}}

    Order

    GET/services/v3/orders/{orderGuid}/uservalues

    Gets all user values from order.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Uri

    • orderGuidguidREQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    • contentTransferEncodingstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","contentTransferEncoding" : "string"}]}}

    Order

    GET/services/v3/orders/{orderGuid}/uservalues/{key}

    Gets a specific user value by specified key from order. If checksum is supplied, the user value is streamed in the response instead of in json output.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Uri

    • orderGuidguidREQUIRED

    • keystringREQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    • contentTransferEncodingstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","contentTransferEncoding" : "string"}}

    Order

    GET/services/v3/orders/{orderId}

    Gets a specific order and its content by its id.

    Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

    Returns state headers.

    REQUEST PARAMETERS

    Parameters from Uri

    • orderIdint32REQUIRED

    • include=description

      SellToAddress is not rendered, unless this condition is specified.
      ShipToAddress is not rendered, unless this condition is specified.
      Annotations are not rendered, unless this condition is specified.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data


      Main properties of a basket.

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • idint32

    • orderGuidguid

    • orderNumberstring

    • orderStatestringEnum

      Possible values:

      creatednewOrdercancelledinProcessbackordershipped

    • lineCountint32

    • itemCountdecimal

    • lineTotal


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • orderTotal


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • dateFinalizeddateTime

    • policiesorderPoliciesEnum

      Possible values:

      ShopFrontAccess

    • sellToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • shipToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • annotation

    • commentstring

    • deliveryDatedateTime

    • shipments

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • isCollectAtStoreboolean

    • payments

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • extPaymentMethodIdstring

    • namestring

    • descriptionstring

    • fee


      Aplicable fee, added to the total value of basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • amountReserved


      Any amount already reserved for payment. Amount due is totalvalue minus sum(AmountReserved)

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • billToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • location

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • locationIdint64


      The ID of the location.
      May be used to fetch a specific location.

    • extLocationIdstring


      Location ext. ID.

    • posIdstring


      Only relevant to locations integrated with an external POS system.

    • isDefaultboolean


      Defines whether the location is default for the current shop.

    • isBuyableboolean


      Defines whether items may be ordered from this location.

    • showAddToBasketboolean


      Defines wheter "add to basket" buttons should be visible for this location.

    • uiSortorderint32


      Sort order value that may be used to order a list of locations according to this value.

    • locationNamestring


      The name of the location.

    • isVisibleInShopboolean


      Defines whether the location should be shown in the shop.
      This flag does no no influence wether this location can be used to sell from.

    • namestring


      Location address name.

    • name2string


      Location address name2.

    • addressstring


      Location Address.

    • address2string


      Location Address2.

    • citystring


      Location address city.

    • postCodestring


      Location address post code.

    • countystring


      Location address county.

    • countryIdint32


      Location address country.

    • emailAddressstring


      Location e-mail address. May receive a copy of order confirmation e-mails.

    • contactstring


      Location contact.

    • phoneNumberstring


      Location phone number.

    • faxNumberstring


      Location fax number.

    • leadTimetimespan


      Location lead time.
      An off-set in hours from the order is placed to when it may be collected at a physical location.

    • openingHours


      Returns any opening hours defined for the location.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • specialOpeningHours


      Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • collectTimesdateTime


      Returns any collect times for the context of the request.
      Setting the "timescope" and "interval" query parameters in the request influences what is returned.

    • currency

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • currencyIdint32

    • extCurrencyIdstring

    • displayNamestring

    • uISortOrderint32

    • namestring

    • iso4217Alpha3string

    • iso4217Numericint32

    • decimalSeparatorstring

    • decimalDigitsint32

    • decimalGroupSeparatorstring

    • groupSizeint32

    • positivePatternint32

    • negativePatternint32

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","orderGuid" : "guid","orderNumber" : "string","orderState" : "created | newOrder | cancelled | inProcess | backorder | shipped","lineCount" : "int32","itemCount" : "decimal","lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"orderTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"dateFinalized" : "dateTime","policies" : "ShopFrontAccess","sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"annotation" : {"comment" : "string","deliveryDate" : "dateTime"},"shipments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"isCollectAtStore" : "boolean"}],"payments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"extPaymentMethodId" : "string","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"amountReserved" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"}}}

    Response codes

    Http response Description
    Returns the content of the order.

    Order

    GET/services/v3/orders/{orderId}/lines

    Gets order lines.

    Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • orderIdint32REQUIRED

    Parameters from Query

    • imagesizetypeids

      A comma-separated list of image size type IDs used for generating item images returned in the response. If this parameter is not set in the request, no item images are returned in the response.

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • lineIdint32

    • itemKeyitemKey


      Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
      The kind of item is determined the the typeOfItem portion if this key.

    • itemIdint32

    • typeOfItemstringEnum

      Possible values:

      producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

    • itemSubTypestringEnum

      Possible values:

      standarddepositdiscount

    • isAmountVisibleboolean

    • isQuantityVisibleboolean

    • isAmountInTotalsboolean

    • externalItemId1string

    • externalItemId2string

    • secondaryIdstring

    • eANstring

    • quantitydecimal

    • lineAmount


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • unitPrice


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • itemUrlstring

    • description1string

    • description2string

    • description3string

    • userCode1string

    • userCode2string

    • userCode3string

    • tagstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"lineId" : "int32","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"itemSubType" : "standard | deposit | discount","isAmountVisible" : "boolean","isQuantityVisible" : "boolean","isAmountInTotals" : "boolean","externalItemId1" : "string","externalItemId2" : "string","secondaryId" : "string","eAN" : "string","quantity" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"itemUrl" : "string","description1" : "string","description2" : "string","description3" : "string","userCode1" : "string","userCode2" : "string","userCode3" : "string","tag" : "string"}]}}

    Order

    GET/services/v3/orders/{orderId}/uservalues

    Gets all user values from order.

    Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • orderIdint32REQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    • contentTransferEncodingstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","contentTransferEncoding" : "string"}]}}

    Order

    GET/services/v3/orders/{orderId}/uservalues/{key}

    Gets a specific user value by specified key from order. If checksum is supplied, the user value is streamed in the response instead of in json output.

    Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • orderIdint32REQUIRED

    • keystringREQUIRED

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • keystring

    • valuestring

    • isVisibleOnOrderboolean

    • contentTypestring

    • contentTransferEncodingstring

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","contentTransferEncoding" : "string"}}

    Order

    GET/services/v3/orders?search={search}&fromDate={fromDate}&toDate={toDate}&p={p}&rp={rp}

    Lists orders available in context of the request. The result set is ordered by creation date descending (newest orders are returned first). Depending on the shop configuration, you may get order(s) from your last visit. Note: You should use the 'auth' api before attempting to use any order api in order to setup a ticket for using orders.

    Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

    REQUEST PARAMETERS

    Parameters from Uri

    • searchstring

    • fromDatestring

    • toDatestring

    • pint32

    • rpint32

    • include=description

      SellToAddress is not rendered, unless this condition is specified.
      ShipToAddress is not rendered, unless this condition is specified.
      Annotations are not rendered, unless this condition is specified.

    Parameters from Query

    • search

      Searches in order number, customer ID and company name

    RESPONSE

    Response fields

    • idstring


      Represents a unique ID for the task carried out by a request.
      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
      The Id is required in Api response.

    • apiVersionstring


      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

    • contextstring


      Echoes the context from the original request.
      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

    • servedBystring


      This states a name of the actual server serving the response.
      This has no practical use other but supplying an ensurance of the platform in service.

    • timeServedstring


      Returns the time in UTC when the request was created.

    • appVersionstring


      Returns the application build version.

    • tookdouble


      Returns the complete time it took to process the request.

    • data

    • messages

    • severitystringEnum


      The severity of the message.

      Possible values:

      debuginfowarningerrorfatalsecurity

    • messagestring


      Localized message.

    • resultCodestringEnum


      The result code helps you identify what kind of issue the message is about.

      Possible values:

      okwarningnotFoundconstraintFailureunAuthorizedother

    • errorCodestring


      An invariant text string containing identification of the error,
      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

    • kindstring


      Literal reference to what item this message relates to.
      Together with the reference property, this enables you to locate exactly what item was
      the source for this message.

    • referencestring


      Together with kind, this identifies exactly what item caused the message.

    • kindstring

    • currentItemCountint32

    • totalItemsint32

    • grossItemsint32

    • itemsPerPageint32

    • startIndexint32

    • pagingLinkTemplatestring

    • pageIndexint32

    • totalPagesint32

    • nextLinkstring

    • previousLinkstring

    • attributesobject

    • items

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • idint32

    • orderGuidguid

    • orderNumberstring

    • orderStatestringEnum

      Possible values:

      creatednewOrdercancelledinProcessbackordershipped

    • lineCountint32

    • itemCountdecimal

    • lineTotal


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • orderTotal


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • dateFinalizeddateTime

    • policiesorderPoliciesEnum

      Possible values:

      ShopFrontAccess

    • sellToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • shipToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • annotation

    • commentstring

    • deliveryDatedateTime

    • shipments

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • namestring

    • descriptionstring

    • fee


      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • isCollectAtStoreboolean

    • payments

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • extPaymentMethodIdstring

    • namestring

    • descriptionstring

    • fee


      Aplicable fee, added to the total value of basket.

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • amountReserved


      Any amount already reserved for payment. Amount due is totalvalue minus sum(AmountReserved)

      A special implementation of IPrice, that targets api usage.

    • currencySymbolstring

    • vatPercentagedecimal

    • vatAmountdecimal

    • isPriceIncVatboolean

    • priceIncVatdecimal

    • priceExVatdecimal

    • tagPricedecimal

    • billToAddress

    • isEnabledboolean

    • isConfirmedboolean

    • constraints

    • fieldNamestring

    • kindkindOfField

    • fieldPolicystring

    • lookupstring

    • regExValidationstring

    • maxLengthint32

    • lowerBounddecimal

    • upperBounddecimal

    • companyNamestring

    • attentionstring

    • namestring

    • addressstring

    • address2string

    • zipCodestring

    • citystring

    • country

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • countryIdint32

    • extCountryIdstring

    • namestring

    • isDefaultCountryboolean

    • sortOrderint32

    • iso3166Alpha3string

    • iso3166Alpha2string

    • emailstring

    • referencestring

    • phoneNumberstring

    • mobilePhoneNumberstring

    • faxNumberstring

    • vATNumberstring

    • eInvoiceCustomerReferencestring

    • eInvoiceCustomerExtDocNostring

    • eInvoiceCustomerReceiverCodestring

    • eInvoiceCustomerIntPostingNostring

    • location

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • locationIdint64


      The ID of the location.
      May be used to fetch a specific location.

    • extLocationIdstring


      Location ext. ID.

    • posIdstring


      Only relevant to locations integrated with an external POS system.

    • isDefaultboolean


      Defines whether the location is default for the current shop.

    • isBuyableboolean


      Defines whether items may be ordered from this location.

    • showAddToBasketboolean


      Defines wheter "add to basket" buttons should be visible for this location.

    • uiSortorderint32


      Sort order value that may be used to order a list of locations according to this value.

    • locationNamestring


      The name of the location.

    • isVisibleInShopboolean


      Defines whether the location should be shown in the shop.
      This flag does no no influence wether this location can be used to sell from.

    • namestring


      Location address name.

    • name2string


      Location address name2.

    • addressstring


      Location Address.

    • address2string


      Location Address2.

    • citystring


      Location address city.

    • postCodestring


      Location address post code.

    • countystring


      Location address county.

    • countryIdint32


      Location address country.

    • emailAddressstring


      Location e-mail address. May receive a copy of order confirmation e-mails.

    • contactstring


      Location contact.

    • phoneNumberstring


      Location phone number.

    • faxNumberstring


      Location fax number.

    • leadTimetimespan


      Location lead time.
      An off-set in hours from the order is placed to when it may be collected at a physical location.

    • openingHours


      Returns any opening hours defined for the location.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • specialOpeningHours


      Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

    • validityDatedateTime


      The date of the "special" opening hour.
      Only returned for "special" opening hours.

    • openFromtimespan


      Time of day from when the physical location is open.

    • openTotimespan


      Time of day to when the physical location is open.

    • isClosedboolean


      Flag indicating whether the physical location is open.

    • commentstring


      Optional comment to show for the opening hour (not localized).

    • isOpenForCollectionboolean


      Flag indicating whether the physical location is open for collect orders.

    • collectOpenFromtimespan


      Time of day from when the physical location is open for collect orders.

    • collectOpenTotimespan


      Time of day to when the physical location is open for collect orders.

    • dayOfTheWeekint32


      Numeric representation of the week day.
      0 = Sunday.

    • collectTimesdateTime


      Returns any collect times for the context of the request.
      Setting the "timescope" and "interval" query parameters in the request influences what is returned.

    • currency

    • links

    • rellinkRel


      Specifies what relation this link has to the resource it is declared upon.

    • hrefstring


      Specifies the link to the resource. This would be a relative link.

    • actionlinkAction


      Represents the action suggested to use the resource.

    • titlestring


      The title of the resource, that describes the link.

    • nestedLevelint32


      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

    • sizeTypeIdint32


      For image resources, this represents the image type of the request.

    • targetContentlinkTargetContent


      An abstract content type describing what kind of data to expect from the resource.

    • targetMediaTypestring


      Describes what media type to expect from the resource in a technical described as mime.

    • currencyIdint32

    • extCurrencyIdstring

    • displayNamestring

    • uISortOrderint32

    • namestring

    • iso4217Alpha3string

    • iso4217Numericint32

    • decimalSeparatorstring

    • decimalDigitsint32

    • decimalGroupSeparatorstring

    • groupSizeint32

    • positivePatternint32

    • negativePatternint32

    Response body

    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"id" : "int32","orderGuid" : "guid","orderNumber" : "string","orderState" : "created | newOrder | cancelled | inProcess | backorder | shipped","lineCount" : "int32","itemCount" : "decimal","lineTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"orderTotal" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"dateFinalized" : "dateTime","policies" : "ShopFrontAccess","sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"annotation" : {"comment" : "string","deliveryDate" : "dateTime"},"shipments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"isCollectAtStore" : "boolean"}],"payments" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"extPaymentMethodId" : "string","name" : "string","description" : "string","fee" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"amountReserved" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"}}],"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"}}]}}

    Response codes

    Http response Description
    Returns a list of orders based on date filtering or pagination.

    Order

    GET/sessionservices/v2/order

    Gets list of orders for curently logged in customer. If there is no current customer or you do not have permissions, a 404 is returned.

    Authentication header is not allowed.

    REQUEST PARAMETERS

    Parameters from Query

    • include

      Defines elemets that will be included in response

      Request body

      {
"value" : "",
"value" : "",
"value" : "",
"value" : "",
"value" : "",
"value" : "",
"value" : ""}

      RESPONSE

      Response fields

      • idstring


        Represents a unique ID for the task carried out by a request.
        The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
        The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
        Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
        The Id is required in Api response.

      • apiVersionstring


        This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

      • contextstring


        Echoes the context from the original request.
        This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

      • servedBystring


        This states a name of the actual server serving the response.
        This has no practical use other but supplying an ensurance of the platform in service.

      • timeServedstring


        Returns the time in UTC when the request was created.

      • appVersionstring


        Returns the application build version.

      • tookdouble


        Returns the complete time it took to process the request.

      • data

      • orderIdstring

      • posIdstring

      • barcodestring

      • accountIdint32

      • extShopIdstring

      • extShopGroupIdstring

      • orderDatedateTime

      • orderDateFormattedstring

      • extSalesPersonIdstring

      • salesPersonNamestring

      • extCustomerIdstring

      • currencyISO4217astring

      • currencyExchangeRatedecimal

      • iSO639a3string

      • totalOrderAmount


        A special implementation of IPrice, that targets api usage.

      • currencySymbolstring

      • vatPercentagedecimal

      • vatAmountdecimal

      • isPriceIncVatboolean

      • priceIncVatdecimal

      • priceExVatdecimal

      • tagPricedecimal

      • orderLinesTotalAmount


        A special implementation of IPrice, that targets api usage.

      • currencySymbolstring

      • vatPercentagedecimal

      • vatAmountdecimal

      • isPriceIncVatboolean

      • priceIncVatdecimal

      • priceExVatdecimal

      • tagPricedecimal

      • orderRemarksstring

      • sellTo

      • phoneNumberstring

      • mobilePhoneNostring

      • emailstring

      • yourReferencestring

      • faxNumberstring

      • eanNumberstring

      • eanAccountNumberstring

      • eanReferencestring

      • namestring

      • name2string

      • addressstring

      • address2string

      • citystring

      • contactstring

      • postCodestring

      • countystring

      • countryIdstring

      • countryNamestring

      • deliveryAddress

      • namestring

      • name2string

      • addressstring

      • address2string

      • citystring

      • contactstring

      • postCodestring

      • countystring

      • countryIdstring

      • countryNamestring

      • payments

      • paymentMethodIdstring

      • descriptionstring

      • amount


        A special implementation of IPrice, that targets api usage.

      • currencySymbolstring

      • vatPercentagedecimal

      • vatAmountdecimal

      • isPriceIncVatboolean

      • priceIncVatdecimal

      • priceExVatdecimal

      • tagPricedecimal

      • paymentProvider

      • namestring

      • reservedAmountstring

      • shipments

      • shipmentMethodIdstring

      • descriptionstring

      • amount


        A special implementation of IPrice, that targets api usage.

      • currencySymbolstring

      • vatPercentagedecimal

      • vatAmountdecimal

      • isPriceIncVatboolean

      • priceIncVatdecimal

      • priceExVatdecimal

      • tagPricedecimal

      • shipmentProvider

      • namestring

      • parcelCollect

      • service

      • carrierIdstring

      • barcodestring

      • locationIdstring

      • service

      • parcelTypestring

      • shipmentTypestring

      • destination

      • idstring

      • namestring

      • name2string

      • addressstring

      • address2string

      • citystring

      • postCodestring

      • countystring

      • countryIdstring

      • countryNamestring

      • notification

      • smsNumberstring

      • emailAddressstring

      • instructions

      • leaveUnattendedboolean

      • remarksstring

      • deliveryDateFormattedstring

      • orderLines

      • lineIdint32

      • lineTypeIdstring

      • parentLineIdint32

      • extItemIdstring

      • extVariantIdstring

      • eanNumberstring

      • posIdstring

      • lineDescription1string

      • lineDescription2string

      • lineDescription3string

      • manufacturerSKUstring

      • quantitydecimal

      • vatPercentagedecimal

      • unitPrice


        A special implementation of IPrice, that targets api usage.

      • currencySymbolstring

      • vatPercentagedecimal

      • vatAmountdecimal

      • isPriceIncVatboolean

      • priceIncVatdecimal

      • priceExVatdecimal

      • tagPricedecimal

      • unitPriceDiscountAmount


        A special implementation of IPrice, that targets api usage.

      • currencySymbolstring

      • vatPercentagedecimal

      • vatAmountdecimal

      • isPriceIncVatboolean

      • priceIncVatdecimal

      • priceExVatdecimal

      • tagPricedecimal

      • unitPriceDiscountPercentdecimal

      • lineAmount


        A special implementation of IPrice, that targets api usage.

      • currencySymbolstring

      • vatPercentagedecimal

      • vatAmountdecimal

      • isPriceIncVatboolean

      • priceIncVatdecimal

      • priceExVatdecimal

      • tagPricedecimal

      • sortOrderint32

      • lineTagstring

      • userCode1string

      • userCode2string

      • userCode3string

      • deliveryDatedateTime

      • priceCalculationDatedateTime

      • isAmountInTotalsboolean

      • isSumLineboolean

      • priceListIdstring

      • priceCalculationDatedateTime

      • userValues

      • keystring

      • valuestring

      • contentTypestring

      • valueTypestring

      Response body

      {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"orderId" : "string","posId" : "string","barcode" : "string","accountId" : "int32","extShopId" : "string","extShopGroupId" : "string","orderDate" : "dateTime","orderDateFormatted" : "string","extSalesPersonId" : "string","salesPersonName" : "string","extCustomerId" : "string","currencyISO4217a" : "string","currencyExchangeRate" : "decimal","iSO639a3" : "string","totalOrderAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"orderLinesTotalAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"orderRemarks" : "string","sellTo" : {"phoneNumber" : "string","mobilePhoneNo" : "string","email" : "string","yourReference" : "string","faxNumber" : "string","eanNumber" : "string","eanAccountNumber" : "string","eanReference" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"deliveryAddress" : {"name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"payments" : [{"paymentMethodId" : "string","description" : "string","amount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"paymentProvider" : {"name" : "string","reservedAmount" : "string"}}],"shipments" : [{"shipmentMethodId" : "string","description" : "string","amount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"shipmentProvider" : {"name" : "string"}}],"parcelCollect" : {"service" : {"carrierId" : "string","barcode" : "string","locationId" : "string","service" : {"parcelType" : "string","shipmentType" : "string"}},"destination" : {"id" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"notification" : {"smsNumber" : "string","emailAddress" : "string"},"instructions" : {"leaveUnattended" : "boolean","remarks" : "string","deliveryDateFormatted" : "string"}},"orderLines" : [{"lineId" : "int32","lineTypeId" : "string","parentLineId" : "int32","extItemId" : "string","extVariantId" : "string","eanNumber" : "string","posId" : "string","lineDescription1" : "string","lineDescription2" : "string","lineDescription3" : "string","manufacturerSKU" : "string","quantity" : "decimal","vatPercentage" : "decimal","unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPriceDiscountAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPriceDiscountPercent" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"sortOrder" : "int32","lineTag" : "string","userCode1" : "string","userCode2" : "string","userCode3" : "string","deliveryDate" : "dateTime","priceCalculationDate" : "dateTime","isAmountInTotals" : "boolean","isSumLine" : "boolean"}],"priceListId" : "string","priceCalculationDate" : "dateTime","userValues" : [{"key" : "string","value" : "string","contentType" : "string","valueType" : "string"}]}]}

      Response codes

      Http response Description
      200 OK Everything is fine
      400 BadRequest The request was not understood
      404 NotFound There is no basket context

      Order

      GET/sessionservices/v2/order/{id}

      Gets order with the specified ID. If no current customer is logged in or you do not have permissions, a 404 is returned.

      Authentication header is not allowed.

      REQUEST PARAMETERS

      Parameters from Uri

      • idstringREQUIRED

      Parameters from Query

      • include

        Defines elemets that will be included in response

        Request body

        {
"value" : "",
"value" : "",
"value" : "",
"value" : "",
"value" : "",
"value" : "",
"value" : ""}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data


          Order

        • orderIdstring

        • posIdstring

        • barcodestring

        • accountIdint32

        • extShopIdstring

        • extShopGroupIdstring

        • orderDatedateTime

        • orderDateFormattedstring

        • extSalesPersonIdstring

        • salesPersonNamestring

        • extCustomerIdstring

        • currencyISO4217astring

        • currencyExchangeRatedecimal

        • iSO639a3string

        • totalOrderAmount


          A special implementation of IPrice, that targets api usage.

        • currencySymbolstring

        • vatPercentagedecimal

        • vatAmountdecimal

        • isPriceIncVatboolean

        • priceIncVatdecimal

        • priceExVatdecimal

        • tagPricedecimal

        • orderLinesTotalAmount


          A special implementation of IPrice, that targets api usage.

        • currencySymbolstring

        • vatPercentagedecimal

        • vatAmountdecimal

        • isPriceIncVatboolean

        • priceIncVatdecimal

        • priceExVatdecimal

        • tagPricedecimal

        • orderRemarksstring

        • sellTo

        • phoneNumberstring

        • mobilePhoneNostring

        • emailstring

        • yourReferencestring

        • faxNumberstring

        • eanNumberstring

        • eanAccountNumberstring

        • eanReferencestring

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • contactstring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • deliveryAddress

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • contactstring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • payments

        • paymentMethodIdstring

        • descriptionstring

        • amount


          A special implementation of IPrice, that targets api usage.

        • currencySymbolstring

        • vatPercentagedecimal

        • vatAmountdecimal

        • isPriceIncVatboolean

        • priceIncVatdecimal

        • priceExVatdecimal

        • tagPricedecimal

        • paymentProvider

        • namestring

        • reservedAmountstring

        • shipments

        • shipmentMethodIdstring

        • descriptionstring

        • amount


          A special implementation of IPrice, that targets api usage.

        • currencySymbolstring

        • vatPercentagedecimal

        • vatAmountdecimal

        • isPriceIncVatboolean

        • priceIncVatdecimal

        • priceExVatdecimal

        • tagPricedecimal

        • shipmentProvider

        • namestring

        • parcelCollect

        • service

        • carrierIdstring

        • barcodestring

        • locationIdstring

        • service

        • parcelTypestring

        • shipmentTypestring

        • destination

        • idstring

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • notification

        • smsNumberstring

        • emailAddressstring

        • instructions

        • leaveUnattendedboolean

        • remarksstring

        • deliveryDateFormattedstring

        • orderLines

        • lineIdint32

        • lineTypeIdstring

        • parentLineIdint32

        • extItemIdstring

        • extVariantIdstring

        • eanNumberstring

        • posIdstring

        • lineDescription1string

        • lineDescription2string

        • lineDescription3string

        • manufacturerSKUstring

        • quantitydecimal

        • vatPercentagedecimal

        • unitPrice


          A special implementation of IPrice, that targets api usage.

        • currencySymbolstring

        • vatPercentagedecimal

        • vatAmountdecimal

        • isPriceIncVatboolean

        • priceIncVatdecimal

        • priceExVatdecimal

        • tagPricedecimal

        • unitPriceDiscountAmount


          A special implementation of IPrice, that targets api usage.

        • currencySymbolstring

        • vatPercentagedecimal

        • vatAmountdecimal

        • isPriceIncVatboolean

        • priceIncVatdecimal

        • priceExVatdecimal

        • tagPricedecimal

        • unitPriceDiscountPercentdecimal

        • lineAmount


          A special implementation of IPrice, that targets api usage.

        • currencySymbolstring

        • vatPercentagedecimal

        • vatAmountdecimal

        • isPriceIncVatboolean

        • priceIncVatdecimal

        • priceExVatdecimal

        • tagPricedecimal

        • sortOrderint32

        • lineTagstring

        • userCode1string

        • userCode2string

        • userCode3string

        • deliveryDatedateTime

        • priceCalculationDatedateTime

        • isAmountInTotalsboolean

        • isSumLineboolean

        • priceListIdstring

        • priceCalculationDatedateTime

        • userValues

        • keystring

        • valuestring

        • contentTypestring

        • valueTypestring

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"orderId" : "string","posId" : "string","barcode" : "string","accountId" : "int32","extShopId" : "string","extShopGroupId" : "string","orderDate" : "dateTime","orderDateFormatted" : "string","extSalesPersonId" : "string","salesPersonName" : "string","extCustomerId" : "string","currencyISO4217a" : "string","currencyExchangeRate" : "decimal","iSO639a3" : "string","totalOrderAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"orderLinesTotalAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"orderRemarks" : "string","sellTo" : {"phoneNumber" : "string","mobilePhoneNo" : "string","email" : "string","yourReference" : "string","faxNumber" : "string","eanNumber" : "string","eanAccountNumber" : "string","eanReference" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"deliveryAddress" : {"name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"payments" : [{"paymentMethodId" : "string","description" : "string","amount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"paymentProvider" : {"name" : "string","reservedAmount" : "string"}}],"shipments" : [{"shipmentMethodId" : "string","description" : "string","amount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"shipmentProvider" : {"name" : "string"}}],"parcelCollect" : {"service" : {"carrierId" : "string","barcode" : "string","locationId" : "string","service" : {"parcelType" : "string","shipmentType" : "string"}},"destination" : {"id" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"notification" : {"smsNumber" : "string","emailAddress" : "string"},"instructions" : {"leaveUnattended" : "boolean","remarks" : "string","deliveryDateFormatted" : "string"}},"orderLines" : [{"lineId" : "int32","lineTypeId" : "string","parentLineId" : "int32","extItemId" : "string","extVariantId" : "string","eanNumber" : "string","posId" : "string","lineDescription1" : "string","lineDescription2" : "string","lineDescription3" : "string","manufacturerSKU" : "string","quantity" : "decimal","vatPercentage" : "decimal","unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPriceDiscountAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPriceDiscountPercent" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"sortOrder" : "int32","lineTag" : "string","userCode1" : "string","userCode2" : "string","userCode3" : "string","deliveryDate" : "dateTime","priceCalculationDate" : "dateTime","isAmountInTotals" : "boolean","isSumLine" : "boolean"}],"priceListId" : "string","priceCalculationDate" : "dateTime","userValues" : [{"key" : "string","value" : "string","contentType" : "string","valueType" : "string"}]}}

        Response codes

        Http response Description
        200 OK Everything is fine
        400 BadRequest The request was not understood
        404 NotFound There is no basket context

        Order

        GET/sessionservices/v1/order

        Gets list of orders for curently logged in customer. If there is no current customer or you do not have permissions, a 404 is returned.

        Authentication header is not allowed.

        RESPONSE

        Response fields

        • orderIdstring

        • posIdstring

        • barcodestring

        • accountIdint32

        • extShopIdstring

        • extShopGroupIdstring

        • orderDatedateTime

        • orderDateFormattedstring

        • extSalesPersonIdstring

        • salesPersonNamestring

        • extCustomerIdstring

        • currencyISO4217astring

        • currencyExchangeRatedecimal

        • iSO639a3string

        • totalOrderAmountIncVatFormattedstring

        • totalOrderAmountExVatFormattedstring

        • totalOrderVatAmountFormattedstring

        • orderLinesTotalAmountIncVatFormattedstring

        • orderLinesTotalAmountExVatFormattedstring

        • orderLinesVatAmountFormattedstring

        • orderRemarksstring

        • sellTo

        • phoneNumberstring

        • mobilePhoneNostring

        • emailstring

        • yourReferencestring

        • faxNumberstring

        • eanNumberstring

        • eanAccountNumberstring

        • eanReferencestring

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • contactstring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • deliveryAddress

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • contactstring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • payments

        • paymentMethodIdstring

        • descriptionstring

        • amountExVatFormattedstring

        • amountIncVatFormattedstring

        • vatAmountFormattedstring

        • vatPercentagedecimal

        • paymentProvider

        • namestring

        • reservedAmountstring

        • shipments

        • shipmentMethodIdstring

        • descriptionstring

        • amountExVatFormattedstring

        • amountIncVatFormattedstring

        • vatAmountFormattedstring

        • vatPercentagedecimal

        • shipmentProvider

        • namestring

        • parcelCollect

        • service

        • carrierIdstring

        • barcodestring

        • locationIdstring

        • service

        • parcelTypestring

        • shipmentTypestring

        • destination

        • idstring

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • notification

        • smsNumberstring

        • emailAddressstring

        • instructions

        • leaveUnattendedboolean

        • remarksstring

        • deliveryDateFormattedstring

        • ordeLines

        • lineIdint32

        • lineTypeIdstring

        • parentLineIdint32

        • extItemIdstring

        • extVariantIdstring

        • eanNumberstring

        • posIdstring

        • lineDescription1string

        • lineDescription2string

        • lineDescription3string

        • manufacturerSKUstring

        • quantitydecimal

        • vatPercentagedecimal

        • unitPriceExVatFormattedstring

        • unitPriceIncVatFormattedstring

        • unitPriceVatAmountFormattedstring

        • unitPriceDiscountAmountExVatFormattedstring

        • unitPriceDiscountPercentdecimal

        • lineAmountExVatFormattedstring

        • lineAmountIncVatFormattedstring

        • sortOrderint32

        Response body

        {
"orderId" : "string",
"posId" : "string",
"barcode" : "string",
"accountId" : "int32",
"extShopId" : "string",
"extShopGroupId" : "string",
"orderDate" : "dateTime",
"orderDateFormatted" : "string",
"extSalesPersonId" : "string",
"salesPersonName" : "string",
"extCustomerId" : "string",
"currencyISO4217a" : "string",
"currencyExchangeRate" : "decimal",
"iSO639a3" : "string",
"totalOrderAmountIncVatFormatted" : "string",
"totalOrderAmountExVatFormatted" : "string",
"totalOrderVatAmountFormatted" : "string",
"orderLinesTotalAmountIncVatFormatted" : "string",
"orderLinesTotalAmountExVatFormatted" : "string",
"orderLinesVatAmountFormatted" : "string",
"orderRemarks" : "string",
"sellTo" : {"phoneNumber" : "string","mobilePhoneNo" : "string","email" : "string","yourReference" : "string","faxNumber" : "string","eanNumber" : "string","eanAccountNumber" : "string","eanReference" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},
"deliveryAddress" : {"name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},
"payments" : [{"paymentMethodId" : "string","description" : "string","amountExVatFormatted" : "string","amountIncVatFormatted" : "string","vatAmountFormatted" : "string","vatPercentage" : "decimal","paymentProvider" : {"name" : "string","reservedAmount" : "string"}}],
"shipments" : [{"shipmentMethodId" : "string","description" : "string","amountExVatFormatted" : "string","amountIncVatFormatted" : "string","vatAmountFormatted" : "string","vatPercentage" : "decimal","shipmentProvider" : {"name" : "string"}}],
"parcelCollect" : {"service" : {"carrierId" : "string","barcode" : "string","locationId" : "string","service" : {"parcelType" : "string","shipmentType" : "string"}},"destination" : {"id" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"notification" : {"smsNumber" : "string","emailAddress" : "string"},"instructions" : {"leaveUnattended" : "boolean","remarks" : "string","deliveryDateFormatted" : "string"}},
"ordeLines" : [{"lineId" : "int32","lineTypeId" : "string","parentLineId" : "int32","extItemId" : "string","extVariantId" : "string","eanNumber" : "string","posId" : "string","lineDescription1" : "string","lineDescription2" : "string","lineDescription3" : "string","manufacturerSKU" : "string","quantity" : "decimal","vatPercentage" : "decimal","unitPriceExVatFormatted" : "string","unitPriceIncVatFormatted" : "string","unitPriceVatAmountFormatted" : "string","unitPriceDiscountAmountExVatFormatted" : "string","unitPriceDiscountPercent" : "decimal","lineAmountExVatFormatted" : "string","lineAmountIncVatFormatted" : "string","sortOrder" : "int32"}]}

        Order

        GET/sessionservices/v1/order/{id}

        Gets order with the specified ID. If no current customer is logged in or you do not have permissions, a 404 is returned.

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • idstringREQUIRED

        RESPONSE

        Response fields

        • orderIdstring

        • posIdstring

        • barcodestring

        • accountIdint32

        • extShopIdstring

        • extShopGroupIdstring

        • orderDatedateTime

        • orderDateFormattedstring

        • extSalesPersonIdstring

        • salesPersonNamestring

        • extCustomerIdstring

        • currencyISO4217astring

        • currencyExchangeRatedecimal

        • iSO639a3string

        • totalOrderAmountIncVatFormattedstring

        • totalOrderAmountExVatFormattedstring

        • totalOrderVatAmountFormattedstring

        • orderLinesTotalAmountIncVatFormattedstring

        • orderLinesTotalAmountExVatFormattedstring

        • orderLinesVatAmountFormattedstring

        • orderRemarksstring

        • sellTo

        • phoneNumberstring

        • mobilePhoneNostring

        • emailstring

        • yourReferencestring

        • faxNumberstring

        • eanNumberstring

        • eanAccountNumberstring

        • eanReferencestring

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • contactstring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • deliveryAddress

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • contactstring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • payments

        • paymentMethodIdstring

        • descriptionstring

        • amountExVatFormattedstring

        • amountIncVatFormattedstring

        • vatAmountFormattedstring

        • vatPercentagedecimal

        • paymentProvider

        • namestring

        • reservedAmountstring

        • shipments

        • shipmentMethodIdstring

        • descriptionstring

        • amountExVatFormattedstring

        • amountIncVatFormattedstring

        • vatAmountFormattedstring

        • vatPercentagedecimal

        • shipmentProvider

        • namestring

        • parcelCollect

        • service

        • carrierIdstring

        • barcodestring

        • locationIdstring

        • service

        • parcelTypestring

        • shipmentTypestring

        • destination

        • idstring

        • namestring

        • name2string

        • addressstring

        • address2string

        • citystring

        • postCodestring

        • countystring

        • countryIdstring

        • countryNamestring

        • notification

        • smsNumberstring

        • emailAddressstring

        • instructions

        • leaveUnattendedboolean

        • remarksstring

        • deliveryDateFormattedstring

        • ordeLines

        • lineIdint32

        • lineTypeIdstring

        • parentLineIdint32

        • extItemIdstring

        • extVariantIdstring

        • eanNumberstring

        • posIdstring

        • lineDescription1string

        • lineDescription2string

        • lineDescription3string

        • manufacturerSKUstring

        • quantitydecimal

        • vatPercentagedecimal

        • unitPriceExVatFormattedstring

        • unitPriceIncVatFormattedstring

        • unitPriceVatAmountFormattedstring

        • unitPriceDiscountAmountExVatFormattedstring

        • unitPriceDiscountPercentdecimal

        • lineAmountExVatFormattedstring

        • lineAmountIncVatFormattedstring

        • sortOrderint32

        Response body

        {
"orderId" : "string",
"posId" : "string",
"barcode" : "string",
"accountId" : "int32",
"extShopId" : "string",
"extShopGroupId" : "string",
"orderDate" : "dateTime",
"orderDateFormatted" : "string",
"extSalesPersonId" : "string",
"salesPersonName" : "string",
"extCustomerId" : "string",
"currencyISO4217a" : "string",
"currencyExchangeRate" : "decimal",
"iSO639a3" : "string",
"totalOrderAmountIncVatFormatted" : "string",
"totalOrderAmountExVatFormatted" : "string",
"totalOrderVatAmountFormatted" : "string",
"orderLinesTotalAmountIncVatFormatted" : "string",
"orderLinesTotalAmountExVatFormatted" : "string",
"orderLinesVatAmountFormatted" : "string",
"orderRemarks" : "string",
"sellTo" : {"phoneNumber" : "string","mobilePhoneNo" : "string","email" : "string","yourReference" : "string","faxNumber" : "string","eanNumber" : "string","eanAccountNumber" : "string","eanReference" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},
"deliveryAddress" : {"name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","contact" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},
"payments" : [{"paymentMethodId" : "string","description" : "string","amountExVatFormatted" : "string","amountIncVatFormatted" : "string","vatAmountFormatted" : "string","vatPercentage" : "decimal","paymentProvider" : {"name" : "string","reservedAmount" : "string"}}],
"shipments" : [{"shipmentMethodId" : "string","description" : "string","amountExVatFormatted" : "string","amountIncVatFormatted" : "string","vatAmountFormatted" : "string","vatPercentage" : "decimal","shipmentProvider" : {"name" : "string"}}],
"parcelCollect" : {"service" : {"carrierId" : "string","barcode" : "string","locationId" : "string","service" : {"parcelType" : "string","shipmentType" : "string"}},"destination" : {"id" : "string","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "string","countryName" : "string"},"notification" : {"smsNumber" : "string","emailAddress" : "string"},"instructions" : {"leaveUnattended" : "boolean","remarks" : "string","deliveryDateFormatted" : "string"}},
"ordeLines" : [{"lineId" : "int32","lineTypeId" : "string","parentLineId" : "int32","extItemId" : "string","extVariantId" : "string","eanNumber" : "string","posId" : "string","lineDescription1" : "string","lineDescription2" : "string","lineDescription3" : "string","manufacturerSKU" : "string","quantity" : "decimal","vatPercentage" : "decimal","unitPriceExVatFormatted" : "string","unitPriceIncVatFormatted" : "string","unitPriceVatAmountFormatted" : "string","unitPriceDiscountAmountExVatFormatted" : "string","unitPriceDiscountPercent" : "decimal","lineAmountExVatFormatted" : "string","lineAmountIncVatFormatted" : "string","sortOrder" : "int32"}]}

        Menus

        GET/services/v3/menus

        Returns the entire menu tree.

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • strict=true

          Will limit the selected data to only one menuKind, f.inst productMenu.

        • include=description

          Includes SubTitle property.
          Includes Description property.
          Includes Description2 property.
          Includes SeoHtmlTitle property.
          Includes SeoMetaDescription property.
          Includes SeoMetaKeywords property.
          Includes LayoutText property.

        Parameters from Query

        • imagesizetypeids

          A comma-separated list of image size type IDs used for generating item images returned in the response. If this parameter is not set in the request, no item images are returned in the response.

        • include

          If set to "description", returns SubTitle, Description, Description2, SeoHtmlTitle, SeoMetaDescription, SeoMetaKeywords and LayoutText of items in the response.

        • depth

          The number of levels to return in the page item tree. Example: If depth=0, then only top-level page items are returned. If depth=1, then top-level page items and their immediate children are returned. If this parameter is omitted, all levels are returned.

        • excludeEmptyProductMenus

          When set to "true", it excludes empty product menus from the response.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • items

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • parentMenuKeymenuKey

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • extMenuItemIdstring

        • bookmarkstring

        • sortOrderint32

        • navigateUrlstring

        • navigateTargetstring

        • pageFlowIdint32

        • pageFlowSortOrderint32

        • isPrimaryMenuboolean

        • rootEntrystringEnum

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • lifeTimeIdstring

        • namestring

        • subTitlestring

        • descriptionstring

        • description2string

        • seoHtmlTitlestring

        • seoMetaDescriptionstring

        • seoMetaKeywordsstring

        • layoutTextstring

        • roots

        • entrystringEnum


          Informs what kind of content is expected in nodes of a branch. The TreeBranchContent are generally mapped to specific view(s) of the information presented its nodes, i.e. info page, product listing etc. />

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"parentMenuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"extMenuItemId" : "string","bookmark" : "string","sortOrder" : "int32","navigateUrl" : "string","navigateTarget" : "string","pageFlowId" : "int32","pageFlowSortOrder" : "int32","isPrimaryMenu" : "boolean","rootEntry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","lifeTimeId" : "string","name" : "string","subTitle" : "string","description" : "string","description2" : "string","seoHtmlTitle" : "string","seoMetaDescription" : "string","seoMetaKeywords" : "string","layoutText" : "string"}],"roots" : [{"entry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"}}]}]}

        Menus

        GET/services/v3/menus/{kind}

        Returns the entire menu for the kind requested.

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • kindstringREQUIRED

        • strict=true

          Will limit the selected data to only one menuKind, f.inst productMenu.

        • include=description

          Includes SubTitle property.
          Includes Description property.
          Includes Description2 property.
          Includes SeoHtmlTitle property.
          Includes SeoMetaDescription property.
          Includes SeoMetaKeywords property.
          Includes LayoutText property.

        Parameters from Query

        • imagesizetypeids

          A comma-separated list of image size type IDs used for generating item images returned in the response. If this parameter is not set in the request, no item images are returned in the response.

        • strict

          If set to "true", limits the returned items to the kind specified in the request, e.g. productMenu.

        • include

          If set to "description", returns SubTitle, Description, Description2, SeoHtmlTitle, SeoMetaDescription, SeoMetaKeywords and LayoutText of items in the response.

        • depth

          The number of levels to return in the page item tree. Example: If depth=0, then only top-level page items are returned. If depth=1, then top-level page items and their immediate children are returned. If this parameter is omitted, all levels are returned.

        • excludeEmptyProductMenus

          When set to "true", it excludes empty product menus from the response.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • items

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • parentMenuKeymenuKey

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • extMenuItemIdstring

        • bookmarkstring

        • sortOrderint32

        • navigateUrlstring

        • navigateTargetstring

        • pageFlowIdint32

        • pageFlowSortOrderint32

        • isPrimaryMenuboolean

        • rootEntrystringEnum

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • lifeTimeIdstring

        • namestring

        • subTitlestring

        • descriptionstring

        • description2string

        • seoHtmlTitlestring

        • seoMetaDescriptionstring

        • seoMetaKeywordsstring

        • layoutTextstring

        • roots

        • entrystringEnum


          Informs what kind of content is expected in nodes of a branch. The TreeBranchContent are generally mapped to specific view(s) of the information presented its nodes, i.e. info page, product listing etc. />

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"parentMenuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"extMenuItemId" : "string","bookmark" : "string","sortOrder" : "int32","navigateUrl" : "string","navigateTarget" : "string","pageFlowId" : "int32","pageFlowSortOrder" : "int32","isPrimaryMenu" : "boolean","rootEntry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","lifeTimeId" : "string","name" : "string","subTitle" : "string","description" : "string","description2" : "string","seoHtmlTitle" : "string","seoMetaDescription" : "string","seoMetaKeywords" : "string","layoutText" : "string"}],"roots" : [{"entry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"}}]}]}

        Menus

        GET/services/v3/menus/{kind}/{id}

        Returns a specific menu item.

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • kindstringREQUIRED

        • idint32REQUIRED

        • strict=true

          Will limit the selected data to only one menuKind, f.inst productMenu.

        • include=description

          Includes SubTitle property.
          Includes Description property.
          Includes Description2 property.
          Includes SeoHtmlTitle property.
          Includes SeoMetaDescription property.
          Includes SeoMetaKeywords property.
          Includes LayoutText property.

        Parameters from Query

        • imagesizetypeids

          A comma-separated list of image size type IDs used for generating item images returned in the response. If this parameter is not set in the request, no item images are returned in the response.

        • strict

          If set to "true", limits the returned items to the kind specified in the request, e.g. productMenu.

        • include

          If set to "description", returns SubTitle, Description, Description2, SeoHtmlTitle, SeoMetaDescription, SeoMetaKeywords and LayoutText of items in the response.

        • depth

          The number of levels to return in the page item tree. Example: If depth=0, then only top-level page items are returned. If depth=1, then top-level page items and their immediate children are returned. If this parameter is omitted, all levels are returned.

        • excludeEmptyProductMenus

          When set to "true", it excludes empty product menus from the response.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • items

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • parentMenuKeymenuKey

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • extMenuItemIdstring

        • bookmarkstring

        • sortOrderint32

        • navigateUrlstring

        • navigateTargetstring

        • pageFlowIdint32

        • pageFlowSortOrderint32

        • isPrimaryMenuboolean

        • rootEntrystringEnum

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • lifeTimeIdstring

        • namestring

        • subTitlestring

        • descriptionstring

        • description2string

        • seoHtmlTitlestring

        • seoMetaDescriptionstring

        • seoMetaKeywordsstring

        • layoutTextstring

        • roots

        • entrystringEnum


          Informs what kind of content is expected in nodes of a branch. The TreeBranchContent are generally mapped to specific view(s) of the information presented its nodes, i.e. info page, product listing etc. />

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"parentMenuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"extMenuItemId" : "string","bookmark" : "string","sortOrder" : "int32","navigateUrl" : "string","navigateTarget" : "string","pageFlowId" : "int32","pageFlowSortOrder" : "int32","isPrimaryMenu" : "boolean","rootEntry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","lifeTimeId" : "string","name" : "string","subTitle" : "string","description" : "string","description2" : "string","seoHtmlTitle" : "string","seoMetaDescription" : "string","seoMetaKeywords" : "string","layoutText" : "string"}],"roots" : [{"entry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"}}]}]}

        Menus

        GET/services/v3/menus/{kind}/{id}/images/{imageId}/stream/{imageSizeTypeId}?rev={rev}

        Returns a http stream for the image.

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • kindstringREQUIRED

        • idint32REQUIRED

        • imageIdint32REQUIRED

        • imageSizeTypeIdint32REQUIRED

        • revstring

        Logging

        POST/services/v3/logs

        Authentication header is not allowed.

        HMAC authorization header is required.

        Returns state headers.

        REQUEST PARAMETERS

        Parameters from Body

        • severitystringEnum


          The severity of the information logged.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • descriptionstring


          An elaborate description of the log. this may include stack traces and other detailed information to help sort out the problem.

        • headerstring


          A short description of the log.

        • logDatestring


          The point in time the log was initially created in (iso8601 format)

        • hostOsstring


          Provides an hint on the host operating system issuing the log.

        • hostOsVersionstring


          Provides a hint on the host operating system version issuing the log.

        • appInstallationIdstring


          Provides a unique hint on the installation on the device.
          This is not an id of the device, but an id of actual installation of the app on a device.

        • appNamestring


          A string that identifies the app issuing the log.

        • appServicestring


          A string that identifies the the service that is issuing the log. For main app, this is the same as AppName,
          for background services, this is the name of the background service.

        • appComponentstring


          Provides an identification of the module / component / layer / sub-part of the app issuing the log.

        • appVersionstring


          The version of the app

        • exceptionsstring


          An optional space delimited list of exceptions.

        • exceptionDetailsstring


          An optional detailed exception description, possibly including a stack trace, that provides plenty of info for debugging and problem resolving.

        • keywordsstring


          Keywords are used to subdivide and / or group information under an application, enabling Kibana to precisely target specific information.

        • timing1timespan


          Provides timing for a particular information in an aggregatable format.

        • timing1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure.

        • timing2timespan


          Provides timing for a particular information in an aggregatable format.

        • timing2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • timing3timespan


          Provides timing for a particular information in an aggregatable format.

        • timing3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • timing4timespan


          Provides timing for a particular information in an aggregatable format.

        • timing4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count1int64


          Provides count for a particular information in an aggregatable format.

        • count1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count2int64


          Provides count for a particular information in an aggregatable format.

        • count2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count3int64


          Provides count for a particular information in an aggregatable format.

        • count3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count4int64


          Provides count for a particular information in an aggregatable format.

        • count4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key1Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key2Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key3Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key4Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        Request body

        {"severity" : "debug | info | warning | error | fatal | security",
"description" : "string",
"header" : "string",
"logDate" : "string",
"hostOs" : "string",
"hostOsVersion" : "string",
"appInstallationId" : "string",
"appName" : "string",
"appService" : "string",
"appComponent" : "string",
"appVersion" : "string",
"exceptions" : "string",
"exceptionDetails" : "string",
"keywords" : "string",
"timing1" : "timespan",
"timing1Name" : "string",
"timing2" : "timespan",
"timing2Name" : "string",
"timing3" : "timespan",
"timing3Name" : "string",
"timing4" : "timespan",
"timing4Name" : "string",
"count1" : "int64",
"count1Name" : "string",
"count2" : "int64",
"count2Name" : "string",
"count3" : "int64",
"count3Name" : "string",
"count4" : "int64",
"count4Name" : "string",
"key1Name" : "string",
"key1Value" : "string",
"key2Name" : "string",
"key2Value" : "string",
"key3Name" : "string",
"key3Value" : "string",
"key4Name" : "string",
"key4Value" : "string"}

        RESPONSE

        Response codes

        Http response Description
        200 OK Logging succeeded.

        Logging

        POST/services/v3/logs/test

        Authentication header is not allowed.

        HMAC authorization header is required.

        Returns state headers.

        REQUEST PARAMETERS

        Parameters from Body

        • severitystringEnum


          The severity of the information logged.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • descriptionstring


          An elaborate description of the log. this may include stack traces and other detailed information to help sort out the problem.

        • headerstring


          A short description of the log.

        • logDatestring


          The point in time the log was initially created in (iso8601 format)

        • hostOsstring


          Provides an hint on the host operating system issuing the log.

        • hostOsVersionstring


          Provides a hint on the host operating system version issuing the log.

        • appInstallationIdstring


          Provides a unique hint on the installation on the device.
          This is not an id of the device, but an id of actual installation of the app on a device.

        • appNamestring


          A string that identifies the app issuing the log.

        • appServicestring


          A string that identifies the the service that is issuing the log. For main app, this is the same as AppName,
          for background services, this is the name of the background service.

        • appComponentstring


          Provides an identification of the module / component / layer / sub-part of the app issuing the log.

        • appVersionstring


          The version of the app

        • exceptionsstring


          An optional space delimited list of exceptions.

        • exceptionDetailsstring


          An optional detailed exception description, possibly including a stack trace, that provides plenty of info for debugging and problem resolving.

        • keywordsstring


          Keywords are used to subdivide and / or group information under an application, enabling Kibana to precisely target specific information.

        • timing1timespan


          Provides timing for a particular information in an aggregatable format.

        • timing1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure.

        • timing2timespan


          Provides timing for a particular information in an aggregatable format.

        • timing2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • timing3timespan


          Provides timing for a particular information in an aggregatable format.

        • timing3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • timing4timespan


          Provides timing for a particular information in an aggregatable format.

        • timing4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count1int64


          Provides count for a particular information in an aggregatable format.

        • count1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count2int64


          Provides count for a particular information in an aggregatable format.

        • count2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count3int64


          Provides count for a particular information in an aggregatable format.

        • count3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count4int64


          Provides count for a particular information in an aggregatable format.

        • count4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key1Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key2Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key3Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key4Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        Request body

        {"severity" : "debug | info | warning | error | fatal | security",
"description" : "string",
"header" : "string",
"logDate" : "string",
"hostOs" : "string",
"hostOsVersion" : "string",
"appInstallationId" : "string",
"appName" : "string",
"appService" : "string",
"appComponent" : "string",
"appVersion" : "string",
"exceptions" : "string",
"exceptionDetails" : "string",
"keywords" : "string",
"timing1" : "timespan",
"timing1Name" : "string",
"timing2" : "timespan",
"timing2Name" : "string",
"timing3" : "timespan",
"timing3Name" : "string",
"timing4" : "timespan",
"timing4Name" : "string",
"count1" : "int64",
"count1Name" : "string",
"count2" : "int64",
"count2Name" : "string",
"count3" : "int64",
"count3Name" : "string",
"count4" : "int64",
"count4Name" : "string",
"key1Name" : "string",
"key1Value" : "string",
"key2Name" : "string",
"key2Value" : "string",
"key3Name" : "string",
"key3Value" : "string",
"key4Name" : "string",
"key4Value" : "string"}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • severitystringEnum


          The severity of the information logged.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • descriptionstring


          An elaborate description of the log. this may include stack traces and other detailed information to help sort out the problem.

        • headerstring


          A short description of the log.

        • logDatestring


          The point in time the log was initially created in (iso8601 format)

        • hostOsstring


          Provides an hint on the host operating system issuing the log.

        • hostOsVersionstring


          Provides a hint on the host operating system version issuing the log.

        • appInstallationIdstring


          Provides a unique hint on the installation on the device.
          This is not an id of the device, but an id of actual installation of the app on a device.

        • appNamestring


          A string that identifies the app issuing the log.

        • appServicestring


          A string that identifies the the service that is issuing the log. For main app, this is the same as AppName,
          for background services, this is the name of the background service.

        • appComponentstring


          Provides an identification of the module / component / layer / sub-part of the app issuing the log.

        • appVersionstring


          The version of the app

        • exceptionsstring


          An optional space delimited list of exceptions.

        • exceptionDetailsstring


          An optional detailed exception description, possibly including a stack trace, that provides plenty of info for debugging and problem resolving.

        • keywordsstring


          Keywords are used to subdivide and / or group information under an application, enabling Kibana to precisely target specific information.

        • timing1timespan


          Provides timing for a particular information in an aggregatable format.

        • timing1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure.

        • timing2timespan


          Provides timing for a particular information in an aggregatable format.

        • timing2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • timing3timespan


          Provides timing for a particular information in an aggregatable format.

        • timing3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • timing4timespan


          Provides timing for a particular information in an aggregatable format.

        • timing4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count1int64


          Provides count for a particular information in an aggregatable format.

        • count1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count2int64


          Provides count for a particular information in an aggregatable format.

        • count2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count3int64


          Provides count for a particular information in an aggregatable format.

        • count3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • count4int64


          Provides count for a particular information in an aggregatable format.

        • count4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key1Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key1Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key2Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key2Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key3Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key3Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        • key4Namestring


          Provides a (short) name, helping the log viewer staff interpreting the figure

        • key4Valuestring


          Provides a key that can be used for grouping log results (as opposed to keywords that are used for filtering.

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"severity" : "debug | info | warning | error | fatal | security","description" : "string","header" : "string","logDate" : "string","hostOs" : "string","hostOsVersion" : "string","appInstallationId" : "string","appName" : "string","appService" : "string","appComponent" : "string","appVersion" : "string","exceptions" : "string","exceptionDetails" : "string","keywords" : "string","timing1" : "timespan","timing1Name" : "string","timing2" : "timespan","timing2Name" : "string","timing3" : "timespan","timing3Name" : "string","timing4" : "timespan","timing4Name" : "string","count1" : "int64","count1Name" : "string","count2" : "int64","count2Name" : "string","count3" : "int64","count3Name" : "string","count4" : "int64","count4Name" : "string","key1Name" : "string","key1Value" : "string","key2Name" : "string","key2Value" : "string","key3Name" : "string","key3Value" : "string","key4Name" : "string","key4Value" : "string"}]}

        Customer

        POST/services/v3/customers

        Creates a new customer and associated login.

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Body

        • validationFlowloginValidationFlowsEnum


          Defines what validation flow is used for customer creation.
          Currently only "NoVerification,PasswordOnCreation" validation flow is supported.

          Possible values:

          NoVerificationOauthVerificationPasswordOnCreationPasswordOnVerificationTokenByMailTokenBySmsTokenVerification

        • userNamestring


          Username of the customer login.

        • emailstring


          E-mail address of the customer login.
          If set, this will be the recipient of order confirmation e-mails.

        • passwordstring


          Password of the customer login.

        • namestring


          Name of the user.
          May be used to display personalized messages when the user authenticates.

        • languageIdint32


          The preferred language of the customer login.

        • currencyIdint32


          The preferred currency of the customer login.

        • sellToAddress

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • countryIdint32

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        Request body

        {"validationFlow" : "NoVerification | OauthVerification | PasswordOnCreation | PasswordOnVerification | TokenByMail | TokenBySms | TokenVerification",
"userName" : "string",
"email" : "string",
"password" : "string",
"name" : "string",
"languageId" : "int32",
"currencyId" : "int32",
"sellToAddress" : {"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","countryId" : "int32","email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"}}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • login

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerLoginIdint32


          Customer login ID.

        • userNamestring


          Customer login username.

        • emailstring


          Customer login e-mail address.

        • namestring


          Name of the user.
          May be used to display personalized messages.

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • constraints


          Defines the constraints and policies of the resource - that is, what fields are enabled and the policies for updating fields.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • customer

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerIdint32


          Customer ID.

        • extCustomerIdstring


          Ext. customer ID.

        • policiescustomerPoliciesEnum


          The policies of the customer - that is information about what actions are possible for the customer.

          Possible values:

          CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

        • currency


          The currency that should be considered preferred by customer if any.

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • billToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • sellToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • shipToAddresses

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"login" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerLoginId" : "int32","userName" : "string","email" : "string","name" : "string","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]},"customer" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]}}}

        Response codes

        Http response Description
        Returns the created customer and login.

        Customer

        GET/services/v3/customers/current

        Get the customer and login information that corresponds to the supplied authentication.

        Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

        Returns state headers.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • login

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerLoginIdint32


          Customer login ID.

        • userNamestring


          Customer login username.

        • emailstring


          Customer login e-mail address.

        • namestring


          Name of the user.
          May be used to display personalized messages.

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • constraints


          Defines the constraints and policies of the resource - that is, what fields are enabled and the policies for updating fields.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • customer

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerIdint32


          Customer ID.

        • extCustomerIdstring


          Ext. customer ID.

        • policiescustomerPoliciesEnum


          The policies of the customer - that is information about what actions are possible for the customer.

          Possible values:

          CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

        • currency


          The currency that should be considered preferred by customer if any.

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • billToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • sellToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • shipToAddresses

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"login" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerLoginId" : "int32","userName" : "string","email" : "string","name" : "string","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]},"customer" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]}}}

        Response codes

        Http response Description
        Returns the login and customer information for the current authentication.

        Customer

        DELETE/services/v3/customers/current

        Delete Current Customer

        Authentication header is required with one of the following roles: Customer

        REQUEST PARAMETERS

        Parameters from Body

        • passwordstring

        Request body

        {
"password" : "string"}

        RESPONSE

        Response codes

        Http response Description
        204 NoContent The delete succeeded.

        Customer

        PATCH/services/v3/customers/current

        Updates properties on authenticated customer.

        Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

        REQUEST PARAMETERS

        Parameters from Body

        • defaultShipToAddressIdint32

        • currencyIdint32


          The preferred currency of the customer.

        Request body

        {
"defaultShipToAddressId" : "int32",
"currencyId" : "int32"}

        RESPONSE

        Response codes

        Http response Description
        204 NoContent The update succeeded.

        Customer

        POST/services/v3/customers/current/delete

        Delete Current Customer

        Authentication header is required with one of the following roles: Customer

        REQUEST PARAMETERS

        Parameters from Body

        • passwordstring

        Request body

        {
"password" : "string"}

        RESPONSE

        Response codes

        Http response Description
        204 NoContent The delete succeeded.

        Customer

        PATCH/services/v3/customers/current/logins/current

        Updates properties on the login authenticated.

        Authentication header is required with one of the following roles: Customer

        REQUEST PARAMETERS

        Parameters from Body

        • usernamestring


          The new username of the customer login.

        • passwordstring


          The new password of the customer login.

        • oldPasswordstring


          The "old" password of the customer login.
          Must match the existing password of the login, otherwise the request will fail.

        • emailstring


          The new e-mail address of the customer login.
          If set, this will be the recipient of order confirmation e-mails.

        • namestring


          The new name of the user.
          May be used to display personalized messages when the user authenticates.

        • currencyIdint32


          The preferred currency of the customer login.

        • languageIdint32


          The preferred language of the customer login.

        Request body

        {
"username" : "string",
"password" : "string",
"oldPassword" : "string",
"email" : "string",
"name" : "string",
"currencyId" : "int32",
"languageId" : "int32"}

        RESPONSE

        Response codes

        Http response Description
        204 NoContent The update succeeded.

        Customer

        PUT/services/v3/customers/current/selltoaddress

        Update sell to address on authenticated customer.

        Authentication header is required with one of the following roles: Customer, SalesPersonWithCustomerInContext

        REQUEST PARAMETERS

        Parameters from Body

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • countryIdint32

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        Request body

        {
"companyName" : "string",
"attention" : "string",
"name" : "string",
"address" : "string",
"address2" : "string",
"zipCode" : "string",
"city" : "string",
"countryId" : "int32",
"email" : "string",
"reference" : "string",
"phoneNumber" : "string",
"mobilePhoneNumber" : "string",
"faxNumber" : "string",
"vATNumber" : "string",
"eInvoiceCustomerReference" : "string",
"eInvoiceCustomerExtDocNo" : "string",
"eInvoiceCustomerReceiverCode" : "string",
"eInvoiceCustomerIntPostingNo" : "string"}

        RESPONSE

        Response codes

        Http response Description
        204 NoContent The update succeeded.

        Customer

        GET/services/v3/customers/current/shipToAddresses

        Get the customer all shipement addresses.

        Authentication header is required with one of the following roles: Customer

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • messages

        • severitystringEnum


          The severity of the message.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • messagestring


          Localized message.

        • resultCodestringEnum


          The result code helps you identify what kind of issue the message is about.

          Possible values:

          okwarningnotFoundconstraintFailureunAuthorizedother

        • errorCodestring


          An invariant text string containing identification of the error,
          i.e. a never-changing non-localized text code usable for programmatic handling of the message.

        • kindstring


          Literal reference to what item this message relates to.
          Together with the reference property, this enables you to locate exactly what item was
          the source for this message.

        • referencestring


          Together with kind, this identifies exactly what item caused the message.

        • kindstring

        • currentItemCountint32

        • totalItemsint32

        • grossItemsint32

        • itemsPerPageint32

        • startIndexint32

        • pagingLinkTemplatestring

        • pageIndexint32

        • totalPagesint32

        • nextLinkstring

        • previousLinkstring

        • attributesobject

        • items

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]}}

        Response codes

        Http response Description
        Returns the customer addresses information for the current authentication.

        Customer

        POST/services/v3/customers/current/shipToAddresses

        Creates a new customer delivery address

        Authentication header is required with one of the following roles: Customer

        REQUEST PARAMETERS

        Parameters from Body

        • extCustomerDeliveryAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • countryIdint32

        Request body

        {
"extCustomerDeliveryAddressId" : "string",
"companyName" : "string",
"name" : "string",
"attention" : "string",
"address" : "string",
"address2" : "string",
"zipCode" : "string",
"city" : "string",
"countryId" : "int32"}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}}

        Response codes

        Http response Description
        Returns the created customer delivery address.

        Customer

        DELETE/services/v3/customers/current/shipToAddresses

        Delete Current Customer all delivery address

        Authentication header is required with one of the following roles: Customer

        RESPONSE

        Response codes

        Http response Description
        204 NoContent The delete succeeded.

        Customer

        GET/services/v3/customers/current/shipToAddresses/{shipToAddressId}

        Get the customer specific address.

        Authentication header is required with one of the following roles: Customer

        REQUEST PARAMETERS

        Parameters from Uri

        • shipToAddressIdint32REQUIRED

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}}

        Response codes

        Http response Description
        Returns the customer specfic address information for the current authentication.

        Customer

        PUT/services/v3/customers/current/shipToAddresses/{shipToAddressId}

        Updates a customer delivery address

        Authentication header is required with one of the following roles: Customer

        REQUEST PARAMETERS

        Parameters from Uri

        • shipToAddressIdint32REQUIRED

        Parameters from Body

        • extCustomerDeliveryAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • countryIdint32

        Request body

        {
"extCustomerDeliveryAddressId" : "string",
"companyName" : "string",
"name" : "string",
"attention" : "string",
"address" : "string",
"address2" : "string",
"zipCode" : "string",
"city" : "string",
"countryId" : "int32"}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}}

        Response codes

        Http response Description
        Returns the updated customer delivery address.

        Customer

        DELETE/services/v3/customers/current/shipToAddresses/{shipToAddressId}

        Delete Current Customer specific delivery address

        Authentication header is required with one of the following roles: Customer

        REQUEST PARAMETERS

        Parameters from Uri

        • shipToAddressIdint32REQUIRED

        RESPONSE

        Response codes

        Http response Description
        204 NoContent The delete succeeded.

        Customer

        GET/services/v3/customers/policies

        Get policies that applies to customer and login creation.

        Authentication header is not allowed.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • settings

        • keystring

        • valueobject

        • modulestring

        • isModuleImplementationboolean


          Indicates if the configuration value is a module implementation.
          Module implementations facilitates different behaviour for modules, and may radically change
          behaviour, data model, data store etc for the module.
          You may use this information to customize behaviour of your app.

        • implementationstring


          Indicates what module implementation this parameter works for.

        • aliasesstring

        • loginPropertyConstraints


          Defines which fields are enabled for the customer login as well as the policies for updating information.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • sellToAddressConstraints


          Defines which fields are enabled for the customer sellto address as well as the policies for updating information.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • shipToAddressConstraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"settings" : [{"key" : "string","value" : "object","module" : "string","isModuleImplementation" : "boolean","implementation" : "string","aliases" : "string"}],"loginPropertyConstraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"sellToAddressConstraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"shipToAddressConstraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}}

        Response codes

        Http response Description
        Returns the policies that applies to customer and login creation.

        Menuitemrelations

        GET/services/v3/menuitemrelations?itemKeys={itemKeys}

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • itemKeysstringREQUIRED

        • strict=true

          Will limit the selected data to only one menuKind, f.inst productMenu.

        • include=description

          Includes SubTitle property.
          Includes Description property.
          Includes Description2 property.
          Includes SeoHtmlTitle property.
          Includes SeoMetaDescription property.
          Includes SeoMetaKeywords property.
          Includes LayoutText property.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • items

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • parentMenuKeymenuKey

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        • extMenuItemIdstring

        • bookmarkstring

        • sortOrderint32

        • navigateUrlstring

        • navigateTargetstring

        • pageFlowIdint32

        • pageFlowSortOrderint32

        • isPrimaryMenuboolean

        • rootEntrystringEnum

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • lifeTimeIdstring

        • namestring

        • subTitlestring

        • descriptionstring

        • description2string

        • seoHtmlTitlestring

        • seoMetaDescriptionstring

        • seoMetaKeywordsstring

        • layoutTextstring

        • roots

        • entrystringEnum


          Informs what kind of content is expected in nodes of a branch. The TreeBranchContent are generally mapped to specific view(s) of the information presented its nodes, i.e. info page, product listing etc. />

          Possible values:

          pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

        • menuKeymenuKey


          Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

        • menuIdint32

        • menuKindstringEnum

          Possible values:

          PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"parentMenuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"extMenuItemId" : "string","bookmark" : "string","sortOrder" : "int32","navigateUrl" : "string","navigateTarget" : "string","pageFlowId" : "int32","pageFlowSortOrder" : "int32","isPrimaryMenu" : "boolean","rootEntry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","lifeTimeId" : "string","name" : "string","subTitle" : "string","description" : "string","description2" : "string","seoHtmlTitle" : "string","seoMetaDescription" : "string","seoMetaKeywords" : "string","layoutText" : "string"}],"roots" : [{"entry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"}}]}]}

        ProductLocations

        GET/services/v3/productlocations?itemKeys={itemKeys}

        Returns ProductLocations identifier by a json formatted array of item keys, i.e. [{"itemId":1212002,"typeOfItem":"product"}]

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • itemKeysstringREQUIRED

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • messages

        • severitystringEnum


          The severity of the message.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • messagestring


          Localized message.

        • resultCodestringEnum


          The result code helps you identify what kind of issue the message is about.

          Possible values:

          okwarningnotFoundconstraintFailureunAuthorizedother

        • errorCodestring


          An invariant text string containing identification of the error,
          i.e. a never-changing non-localized text code usable for programmatic handling of the message.

        • kindstring


          Literal reference to what item this message relates to.
          Together with the reference property, this enables you to locate exactly what item was
          the source for this message.

        • referencestring


          Together with kind, this identifies exactly what item caused the message.

        • kindstring

        • currentItemCountint32

        • totalItemsint32

        • grossItemsint32

        • itemsPerPageint32

        • startIndexint32

        • pagingLinkTemplatestring

        • pageIndexint32

        • totalPagesint32

        • nextLinkstring

        • previousLinkstring

        • attributesobject

        • items

        • productLocations

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • itemKeyitemKey


          Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
          The kind of item is determined the the typeOfItem portion if this key.

        • itemIdint32

        • typeOfItemstringEnum

          Possible values:

          producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

        • locationIdint64

        • extLocationIdstring

        • isBuyableboolean

        • isVisibleInShopboolean

        • stocklevelint32

        • isStockBoundboolean

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"productLocations" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"locationId" : "int64","extLocationId" : "string","isBuyable" : "boolean","isVisibleInShop" : "boolean","stocklevel" : "int32","isStockBound" : "boolean"}]}]}}

        Auth

        POST/services/v3/auth/authenticate

        Generates authentication and ticket required or recommended for various api resources.

        Authentication header is optional.

        Returns state headers.

        REQUEST PARAMETERS

        Parameters from Body

        • rolestringEnum


          Role to be authenticated.
          Unless role is "anonymous", username and password must be provided in the request.

          Possible values:

          noneanonymouscustomersalesperson

        • userNamestring


          Username of the login.

        • passwordstring


          Password of the login.

        • visitorGuidguid


          Intended for future functionality.

        Request body

        {"role" : "none | anonymous | customer | salesperson",
"userName" : "string",
"password" : "string",
"visitorGuid" : "guid"}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • rolestringEnum

          Possible values:

          noneanonymouscustomersalesperson

        • authenticationstring


          This is the same as set in authentication header in the request.

        • ticketstring


          This is the same as set in ticket header in the request.

        • ttlint32


          How long time in seconds you can rely on this authentication.
          If the authentication gets older than this, it should be renewed.
          Why? For two reasons:
          1 - to ensure your authentication does not expire with rejected calls as a result, and
          2 - the Ticket part of the response is used to establish scope for responses, and responses are
          cached based on this scope. Using the same ticket for extended amount of time means you will get
          more hits from cache, but the likelihood of getting stale data from cache will also increase.

        • customerLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerLoginIdint32


          Customer login ID.

        • userNamestring


          Customer login username.

        • emailstring


          Customer login e-mail address.

        • namestring


          Name of the user.
          May be used to display personalized messages.

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • constraints


          Defines the constraints and policies of the resource - that is, what fields are enabled and the policies for updating fields.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • customer

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerIdint32


          Customer ID.

        • extCustomerIdstring


          Ext. customer ID.

        • policiescustomerPoliciesEnum


          The policies of the customer - that is information about what actions are possible for the customer.

          Possible values:

          CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

        • currency


          The currency that should be considered preferred by customer if any.

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • billToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • sellToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • shipToAddresses

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • salesPersonLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salesPersonLoginIdint32

        • userNamestring

        • emailstring

        • salesPerson

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salespersonIdint32


          Salesperson ID

        • extSalespersonIdstring


          Ext. SalespersonID

        • namestring

        • titlestring

        • emailstring

        • phoneNumber1string

        • phoneNumber2string

        • faxstring

        • policiessalesPersonPoliciesEnum

          Possible values:

          EnabledShopFrontAccess

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"role" : "none | anonymous | customer | salesperson","authentication" : "string","ticket" : "string","ttl" : "int32","customerLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerLoginId" : "int32","userName" : "string","email" : "string","name" : "string","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]},"customer" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]},"salesPersonLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salesPersonLoginId" : "int32","userName" : "string","email" : "string"},"salesPerson" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salespersonId" : "int32","extSalespersonId" : "string","name" : "string","title" : "string","email" : "string","phoneNumber1" : "string","phoneNumber2" : "string","fax" : "string","policies" : "Enabled | ShopFrontAccess"}}}

        Response codes

        Http response Description
        Sets headers.

        Auth

        POST/services/v3/auth/hello

        Registers an app with the hosting webshop using a known api key. Depending on the level of trust to the app, the api can return enough info to complete the registration, or the shop owner has to take additional steps to complete the registration.

        Authentication header is not allowed.

        Returns state headers.

        REQUEST PARAMETERS

        Parameters from Body

        • apiKeystring

        • verificationTokenstring


          Used for trusted apps.
          A value, that is used to confirm that the app being approved is indeed the correct one.
          This should be a value displayed by the app on the device, which administrator can see in the backend on
          the registration record, that creates a visual confirmation of the authenticity of the device.

        • registrationSecretstring


          Required if the api key requires you to know it.

        Request body

        {
"apiKey" : "string",
"verificationToken" : "string",
"registrationSecret" : "string"}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • secretKeystring


          Provides a secret key for hmac authorization.
          Normally, this information will have to be entered manually, but in case of an untrusted app,
          you can get this information programmatically. An untrusted app is defined as an app on an untrusted
          device, and is typically and end user app, exposing no other information than the ones that are already
          readily available through public api and web pages. (i.e. the secret key is not really secret at all anyway)

        • installationIdstring


          This is a unique id assigned to the app upon registration.

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"secretKey" : "string","installationId" : "string"}}

        Response codes

        Http response Description
        Sets headers

        Auth

        POST/services/v3/auth/passwordreset

        Send password reset email for specific Customer or SalesPerson by using Email Or UserName

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Body

        • rolestringEnum


          Specify the kind of user you want password reset for.

          Possible values:

          nonecustomersalespersonanonymous

        • emailstring


          Submit either email OR user name, not both.

        • userNamestring


          Submit either email OR user name, not both.

        Request body

        {"role" : "none | customer | salesperson | anonymous",
"email" : "string",
"userName" : "string"}

        RESPONSE

        Response codes

        Http response Description
        204 NoContent Success, no response body supplied.

        Auth

        POST/services/v3/auth/renew

        Renews authentication and ticket required or recommended for various api resources. It is recommended calling this resource according to the ttl of authentication response.. If switching hostname, you should also renew, as the authenication and ticket is bound to a specific shop..

        Authentication header is required with one of the following roles: Visitor, Customer, SalesPerson, SalesPersonWithCustomerInContext

        Returns state headers.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • rolestringEnum

          Possible values:

          noneanonymouscustomersalesperson

        • authenticationstring


          This is the same as set in authentication header in the request.

        • ticketstring


          This is the same as set in ticket header in the request.

        • ttlint32


          How long time in seconds you can rely on this authentication.
          If the authentication gets older than this, it should be renewed.
          Why? For two reasons:
          1 - to ensure your authentication does not expire with rejected calls as a result, and
          2 - the Ticket part of the response is used to establish scope for responses, and responses are
          cached based on this scope. Using the same ticket for extended amount of time means you will get
          more hits from cache, but the likelihood of getting stale data from cache will also increase.

        • customerLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerLoginIdint32


          Customer login ID.

        • userNamestring


          Customer login username.

        • emailstring


          Customer login e-mail address.

        • namestring


          Name of the user.
          May be used to display personalized messages.

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • constraints


          Defines the constraints and policies of the resource - that is, what fields are enabled and the policies for updating fields.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • customer

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerIdint32


          Customer ID.

        • extCustomerIdstring


          Ext. customer ID.

        • policiescustomerPoliciesEnum


          The policies of the customer - that is information about what actions are possible for the customer.

          Possible values:

          CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

        • currency


          The currency that should be considered preferred by customer if any.

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • billToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • sellToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • shipToAddresses

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • salesPersonLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salesPersonLoginIdint32

        • userNamestring

        • emailstring

        • salesPerson

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salespersonIdint32


          Salesperson ID

        • extSalespersonIdstring


          Ext. SalespersonID

        • namestring

        • titlestring

        • emailstring

        • phoneNumber1string

        • phoneNumber2string

        • faxstring

        • policiessalesPersonPoliciesEnum

          Possible values:

          EnabledShopFrontAccess

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"role" : "none | anonymous | customer | salesperson","authentication" : "string","ticket" : "string","ttl" : "int32","customerLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerLoginId" : "int32","userName" : "string","email" : "string","name" : "string","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]},"customer" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]},"salesPersonLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salesPersonLoginId" : "int32","userName" : "string","email" : "string"},"salesPerson" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salespersonId" : "int32","extSalespersonId" : "string","name" : "string","title" : "string","email" : "string","phoneNumber1" : "string","phoneNumber2" : "string","fax" : "string","policies" : "Enabled | ShopFrontAccess"}}}

        Response codes

        Http response Description
        Sets headers

        Auth

        POST/services/v3/auth/setcustomerscope

        Set the specific customer in scope of salesperson authentication.

        Authentication header is required with one of the following roles: SalesPerson, SalesPersonWithCustomerInContext

        Returns state headers.

        REQUEST PARAMETERS

        Parameters from Body

        • customerIdint32


          Setting customerId null clears the customer in scope.

        Request body

        {
"customerId" : "int32"}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • rolestringEnum

          Possible values:

          noneanonymouscustomersalesperson

        • authenticationstring


          This is the same as set in authentication header in the request.

        • ticketstring


          This is the same as set in ticket header in the request.

        • ttlint32


          How long time in seconds you can rely on this authentication.
          If the authentication gets older than this, it should be renewed.
          Why? For two reasons:
          1 - to ensure your authentication does not expire with rejected calls as a result, and
          2 - the Ticket part of the response is used to establish scope for responses, and responses are
          cached based on this scope. Using the same ticket for extended amount of time means you will get
          more hits from cache, but the likelihood of getting stale data from cache will also increase.

        • customerLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerLoginIdint32


          Customer login ID.

        • userNamestring


          Customer login username.

        • emailstring


          Customer login e-mail address.

        • namestring


          Name of the user.
          May be used to display personalized messages.

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • constraints


          Defines the constraints and policies of the resource - that is, what fields are enabled and the policies for updating fields.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • customer

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerIdint32


          Customer ID.

        • extCustomerIdstring


          Ext. customer ID.

        • policiescustomerPoliciesEnum


          The policies of the customer - that is information about what actions are possible for the customer.

          Possible values:

          CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

        • currency


          The currency that should be considered preferred by customer if any.

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • billToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • sellToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • shipToAddresses

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • salesPersonLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salesPersonLoginIdint32

        • userNamestring

        • emailstring

        • salesPerson

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salespersonIdint32


          Salesperson ID

        • extSalespersonIdstring


          Ext. SalespersonID

        • namestring

        • titlestring

        • emailstring

        • phoneNumber1string

        • phoneNumber2string

        • faxstring

        • policiessalesPersonPoliciesEnum

          Possible values:

          EnabledShopFrontAccess

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"role" : "none | anonymous | customer | salesperson","authentication" : "string","ticket" : "string","ttl" : "int32","customerLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerLoginId" : "int32","userName" : "string","email" : "string","name" : "string","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]},"customer" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]},"salesPersonLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salesPersonLoginId" : "int32","userName" : "string","email" : "string"},"salesPerson" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salespersonId" : "int32","extSalespersonId" : "string","name" : "string","title" : "string","email" : "string","phoneNumber1" : "string","phoneNumber2" : "string","fax" : "string","policies" : "Enabled | ShopFrontAccess"}}}

        Response codes

        Http response Description
        Sets headers.

        Auth

        POST/services/v3/auth/verifyhello

        Registers an app with the hosting webshop using a known api key. Depending on the level of trust to the app, the api can return enough info to complete the registration, or the shop owner has to take additional steps to complete the registration.

        Authentication header is not allowed.

        HMAC authorization header is required.

        Returns state headers.

        REQUEST PARAMETERS

        Parameters from Body

        • apiKeystring

        • installationIdstring


          The installation id on which the client is known.

        Request body

        {
"apiKey" : "string",
"installationId" : "string"}

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • secretKeystring


          Provides a secret key for hmac authorization.
          Normally, this information will have to be entered manually, but in case of an untrusted app,
          you can get this information programmatically. An untrusted app is defined as an app on an untrusted
          device, and is typically and end user app, exposing no other information than the ones that are already
          readily available through public api and web pages. (i.e. the secret key is not really secret at all anyway)

        • installationIdstring


          This is a unique id assigned to the app upon registration.

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"secretKey" : "string","installationId" : "string"}}

        Response codes

        Http response Description
        Sets headers

        Context

        GET/services/v3/context

        Returns context information such as currency, language, country. If no parameters are specified in the GET request, it returns default context information for the shop, e.g. currency, language, country.

        Authentication header is optional.

        Returns state headers.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • priceCalculationDatedateTime

        • priceListIdstring

        • inventoryCheckstringEnum

          Possible values:

          suspendedactive

        • isLiveboolean

        • authentication

        • rolestringEnum

          Possible values:

          noneanonymouscustomersalesperson

        • authenticationstring


          This is the same as set in authentication header in the request.

        • ticketstring


          This is the same as set in ticket header in the request.

        • ttlint32


          How long time in seconds you can rely on this authentication.
          If the authentication gets older than this, it should be renewed.
          Why? For two reasons:
          1 - to ensure your authentication does not expire with rejected calls as a result, and
          2 - the Ticket part of the response is used to establish scope for responses, and responses are
          cached based on this scope. Using the same ticket for extended amount of time means you will get
          more hits from cache, but the likelihood of getting stale data from cache will also increase.

        • customerLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerLoginIdint32


          Customer login ID.

        • userNamestring


          Customer login username.

        • emailstring


          Customer login e-mail address.

        • namestring


          Name of the user.
          May be used to display personalized messages.

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • constraints


          Defines the constraints and policies of the resource - that is, what fields are enabled and the policies for updating fields.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • customer

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerIdint32


          Customer ID.

        • extCustomerIdstring


          Ext. customer ID.

        • policiescustomerPoliciesEnum


          The policies of the customer - that is information about what actions are possible for the customer.

          Possible values:

          CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

        • currency


          The currency that should be considered preferred by customer if any.

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • billToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • sellToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • shipToAddresses

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • salesPersonLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salesPersonLoginIdint32

        • userNamestring

        • emailstring

        • salesPerson

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salespersonIdint32


          Salesperson ID

        • extSalespersonIdstring


          Ext. SalespersonID

        • namestring

        • titlestring

        • emailstring

        • phoneNumber1string

        • phoneNumber2string

        • faxstring

        • policiessalesPersonPoliciesEnum

          Possible values:

          EnabledShopFrontAccess

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • location

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • locationIdint64


          The ID of the location.
          May be used to fetch a specific location.

        • extLocationIdstring


          Location ext. ID.

        • posIdstring


          Only relevant to locations integrated with an external POS system.

        • isDefaultboolean


          Defines whether the location is default for the current shop.

        • isBuyableboolean


          Defines whether items may be ordered from this location.

        • showAddToBasketboolean


          Defines wheter "add to basket" buttons should be visible for this location.

        • uiSortorderint32


          Sort order value that may be used to order a list of locations according to this value.

        • locationNamestring


          The name of the location.

        • isVisibleInShopboolean


          Defines whether the location should be shown in the shop.
          This flag does no no influence wether this location can be used to sell from.

        • namestring


          Location address name.

        • name2string


          Location address name2.

        • addressstring


          Location Address.

        • address2string


          Location Address2.

        • citystring


          Location address city.

        • postCodestring


          Location address post code.

        • countystring


          Location address county.

        • countryIdint32


          Location address country.

        • emailAddressstring


          Location e-mail address. May receive a copy of order confirmation e-mails.

        • contactstring


          Location contact.

        • phoneNumberstring


          Location phone number.

        • faxNumberstring


          Location fax number.

        • leadTimetimespan


          Location lead time.
          An off-set in hours from the order is placed to when it may be collected at a physical location.

        • openingHours


          Returns any opening hours defined for the location.

        • validityDatedateTime


          The date of the "special" opening hour.
          Only returned for "special" opening hours.

        • openFromtimespan


          Time of day from when the physical location is open.

        • openTotimespan


          Time of day to when the physical location is open.

        • isClosedboolean


          Flag indicating whether the physical location is open.

        • commentstring


          Optional comment to show for the opening hour (not localized).

        • isOpenForCollectionboolean


          Flag indicating whether the physical location is open for collect orders.

        • collectOpenFromtimespan


          Time of day from when the physical location is open for collect orders.

        • collectOpenTotimespan


          Time of day to when the physical location is open for collect orders.

        • dayOfTheWeekint32


          Numeric representation of the week day.
          0 = Sunday.

        • specialOpeningHours


          Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

        • validityDatedateTime


          The date of the "special" opening hour.
          Only returned for "special" opening hours.

        • openFromtimespan


          Time of day from when the physical location is open.

        • openTotimespan


          Time of day to when the physical location is open.

        • isClosedboolean


          Flag indicating whether the physical location is open.

        • commentstring


          Optional comment to show for the opening hour (not localized).

        • isOpenForCollectionboolean


          Flag indicating whether the physical location is open for collect orders.

        • collectOpenFromtimespan


          Time of day from when the physical location is open for collect orders.

        • collectOpenTotimespan


          Time of day to when the physical location is open for collect orders.

        • dayOfTheWeekint32


          Numeric representation of the week day.
          0 = Sunday.

        • collectTimesdateTime


          Returns any collect times for the context of the request.
          Setting the "timescope" and "interval" query parameters in the request influences what is returned.

        • settings

        • messages

        • severitystringEnum


          The severity of the message.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • messagestring


          Localized message.

        • resultCodestringEnum


          The result code helps you identify what kind of issue the message is about.

          Possible values:

          okwarningnotFoundconstraintFailureunAuthorizedother

        • errorCodestring


          An invariant text string containing identification of the error,
          i.e. a never-changing non-localized text code usable for programmatic handling of the message.

        • kindstring


          Literal reference to what item this message relates to.
          Together with the reference property, this enables you to locate exactly what item was
          the source for this message.

        • referencestring


          Together with kind, this identifies exactly what item caused the message.

        • kindstring

        • currentItemCountint32

        • totalItemsint32

        • grossItemsint32

        • itemsPerPageint32

        • startIndexint32

        • pagingLinkTemplatestring

        • pageIndexint32

        • totalPagesint32

        • nextLinkstring

        • previousLinkstring

        • attributesobject

        • items

        • keystring

        • valueobject

        • modulestring

        • isModuleImplementationboolean


          Indicates if the configuration value is a module implementation.
          Module implementations facilitates different behaviour for modules, and may radically change
          behaviour, data model, data store etc for the module.
          You may use this information to customize behaviour of your app.

        • implementationstring


          Indicates what module implementation this parameter works for.

        • aliasesstring

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"priceCalculationDate" : "dateTime","priceListId" : "string","inventoryCheck" : "suspended | active","isLive" : "boolean","authentication" : {"role" : "none | anonymous | customer | salesperson","authentication" : "string","ticket" : "string","ttl" : "int32","customerLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerLoginId" : "int32","userName" : "string","email" : "string","name" : "string","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]},"customer" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]},"salesPersonLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salesPersonLoginId" : "int32","userName" : "string","email" : "string"},"salesPerson" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salespersonId" : "int32","extSalespersonId" : "string","name" : "string","title" : "string","email" : "string","phoneNumber1" : "string","phoneNumber2" : "string","fax" : "string","policies" : "Enabled | ShopFrontAccess"}},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"settings" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"key" : "string","value" : "object","module" : "string","isModuleImplementation" : "boolean","implementation" : "string","aliases" : "string"}]}}]}

        Context

        GET/sessionservices/v1/context

        Gets current context information

        Authentication header is not allowed.

        RESPONSE

        Response fields

        • priceCalculationDatedateTime

        • priceListIdstring

        • suspendInventoryCheckboolean

        Response body

        {
"priceCalculationDate" : "dateTime",
"priceListId" : "string",
"suspendInventoryCheck" : "boolean"}

        Response codes

        Http response Description
        200 OK Eerything is fine
        400 BadRequest The request was not understood
        404 NotFound There is no basket context

        Context

        POST/sessionservices/v1/context/changecontext

        Change the price calculation context. Use null value in properties to reset to default. Note: Changing pricing context may required the shop to be configured to allow this.

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Body

        • priceCalculationDatedateTime

        • priceListIdstring

        • suspendInventoryCheckboolean

        • authstring

        Request body

        {
"priceCalculationDate" : "dateTime",
"priceListId" : "string",
"suspendInventoryCheck" : "boolean",
"auth" : "string"}

        RESPONSE

        Response fields

        • priceCalculationDatedateTime

        • priceListIdstring

        • suspendInventoryCheckboolean

        • authstring

        Response body

        {
"priceCalculationDate" : "dateTime",
"priceListId" : "string",
"suspendInventoryCheck" : "boolean",
"auth" : "string"}

        Response codes

        Http response Description
        200 OK Eerything is fine
        400 BadRequest The request was not understood
        404 NotFound There is no basket context

        apistate

        GET/sessionservices/v3/apistate

        Pulls context information such as currency, language, country, authentication from server state in API format. This allows you to continue working in stateless V3 API's with work started in (legacy) web based eseller.

        Authentication header is not allowed.

        Returns state headers.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • priceCalculationDatedateTime

        • priceListIdstring

        • inventoryCheckstringEnum

          Possible values:

          suspendedactive

        • isLiveboolean

        • authentication

        • rolestringEnum

          Possible values:

          noneanonymouscustomersalesperson

        • authenticationstring


          This is the same as set in authentication header in the request.

        • ticketstring


          This is the same as set in ticket header in the request.

        • ttlint32


          How long time in seconds you can rely on this authentication.
          If the authentication gets older than this, it should be renewed.
          Why? For two reasons:
          1 - to ensure your authentication does not expire with rejected calls as a result, and
          2 - the Ticket part of the response is used to establish scope for responses, and responses are
          cached based on this scope. Using the same ticket for extended amount of time means you will get
          more hits from cache, but the likelihood of getting stale data from cache will also increase.

        • customerLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerLoginIdint32


          Customer login ID.

        • userNamestring


          Customer login username.

        • emailstring


          Customer login e-mail address.

        • namestring


          Name of the user.
          May be used to display personalized messages.

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • constraints


          Defines the constraints and policies of the resource - that is, what fields are enabled and the policies for updating fields.

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • customer

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerIdint32


          Customer ID.

        • extCustomerIdstring


          Ext. customer ID.

        • policiescustomerPoliciesEnum


          The policies of the customer - that is information about what actions are possible for the customer.

          Possible values:

          CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

        • currency


          The currency that should be considered preferred by customer if any.

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • billToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • sellToAddress

        • isEnabledboolean

        • isConfirmedboolean

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • companyNamestring

        • attentionstring

        • namestring

        • addressstring

        • address2string

        • zipCodestring

        • citystring

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • emailstring

        • referencestring

        • phoneNumberstring

        • mobilePhoneNumberstring

        • faxNumberstring

        • vATNumberstring

        • eInvoiceCustomerReferencestring

        • eInvoiceCustomerExtDocNostring

        • eInvoiceCustomerReceiverCodestring

        • eInvoiceCustomerIntPostingNostring

        • shipToAddresses

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • customerShipToAddressIdint32

        • customerIDint32

        • customerShipToAddressGuidguid

        • extCustomerShipToAddressIdstring

        • companyNamestring

        • namestring

        • attentionstring

        • addressstring

        • address2string

        • zipcodestring

        • citystring

        • countryIdint32

        • isDefaultShipToAddressboolean

        • dateCreateddateTime

        • dateModifieddateTime

        • constraints

        • fieldNamestring

        • kindkindOfField

        • fieldPolicystring

        • lookupstring

        • regExValidationstring

        • maxLengthint32

        • lowerBounddecimal

        • upperBounddecimal

        • salesPersonLogin

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salesPersonLoginIdint32

        • userNamestring

        • emailstring

        • salesPerson

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • salespersonIdint32


          Salesperson ID

        • extSalespersonIdstring


          Ext. SalespersonID

        • namestring

        • titlestring

        • emailstring

        • phoneNumber1string

        • phoneNumber2string

        • faxstring

        • policiessalesPersonPoliciesEnum

          Possible values:

          EnabledShopFrontAccess

        • language

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • languageIdint32

        • nativeNamestring

        • extLanguageIdstring

        • iso639AlphaCode3string

        • iso639AlphaCode2string

        • uiSortOrderint32

        • country

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        • currency

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • currencyIdint32

        • extCurrencyIdstring

        • displayNamestring

        • uISortOrderint32

        • namestring

        • iso4217Alpha3string

        • iso4217Numericint32

        • decimalSeparatorstring

        • decimalDigitsint32

        • decimalGroupSeparatorstring

        • groupSizeint32

        • positivePatternint32

        • negativePatternint32

        • location

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • locationIdint64


          The ID of the location.
          May be used to fetch a specific location.

        • extLocationIdstring


          Location ext. ID.

        • posIdstring


          Only relevant to locations integrated with an external POS system.

        • isDefaultboolean


          Defines whether the location is default for the current shop.

        • isBuyableboolean


          Defines whether items may be ordered from this location.

        • showAddToBasketboolean


          Defines wheter "add to basket" buttons should be visible for this location.

        • uiSortorderint32


          Sort order value that may be used to order a list of locations according to this value.

        • locationNamestring


          The name of the location.

        • isVisibleInShopboolean


          Defines whether the location should be shown in the shop.
          This flag does no no influence wether this location can be used to sell from.

        • namestring


          Location address name.

        • name2string


          Location address name2.

        • addressstring


          Location Address.

        • address2string


          Location Address2.

        • citystring


          Location address city.

        • postCodestring


          Location address post code.

        • countystring


          Location address county.

        • countryIdint32


          Location address country.

        • emailAddressstring


          Location e-mail address. May receive a copy of order confirmation e-mails.

        • contactstring


          Location contact.

        • phoneNumberstring


          Location phone number.

        • faxNumberstring


          Location fax number.

        • leadTimetimespan


          Location lead time.
          An off-set in hours from the order is placed to when it may be collected at a physical location.

        • openingHours


          Returns any opening hours defined for the location.

        • validityDatedateTime


          The date of the "special" opening hour.
          Only returned for "special" opening hours.

        • openFromtimespan


          Time of day from when the physical location is open.

        • openTotimespan


          Time of day to when the physical location is open.

        • isClosedboolean


          Flag indicating whether the physical location is open.

        • commentstring


          Optional comment to show for the opening hour (not localized).

        • isOpenForCollectionboolean


          Flag indicating whether the physical location is open for collect orders.

        • collectOpenFromtimespan


          Time of day from when the physical location is open for collect orders.

        • collectOpenTotimespan


          Time of day to when the physical location is open for collect orders.

        • dayOfTheWeekint32


          Numeric representation of the week day.
          0 = Sunday.

        • specialOpeningHours


          Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

        • validityDatedateTime


          The date of the "special" opening hour.
          Only returned for "special" opening hours.

        • openFromtimespan


          Time of day from when the physical location is open.

        • openTotimespan


          Time of day to when the physical location is open.

        • isClosedboolean


          Flag indicating whether the physical location is open.

        • commentstring


          Optional comment to show for the opening hour (not localized).

        • isOpenForCollectionboolean


          Flag indicating whether the physical location is open for collect orders.

        • collectOpenFromtimespan


          Time of day from when the physical location is open for collect orders.

        • collectOpenTotimespan


          Time of day to when the physical location is open for collect orders.

        • dayOfTheWeekint32


          Numeric representation of the week day.
          0 = Sunday.

        • collectTimesdateTime


          Returns any collect times for the context of the request.
          Setting the "timescope" and "interval" query parameters in the request influences what is returned.

        • settings

        • messages

        • severitystringEnum


          The severity of the message.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • messagestring


          Localized message.

        • resultCodestringEnum


          The result code helps you identify what kind of issue the message is about.

          Possible values:

          okwarningnotFoundconstraintFailureunAuthorizedother

        • errorCodestring


          An invariant text string containing identification of the error,
          i.e. a never-changing non-localized text code usable for programmatic handling of the message.

        • kindstring


          Literal reference to what item this message relates to.
          Together with the reference property, this enables you to locate exactly what item was
          the source for this message.

        • referencestring


          Together with kind, this identifies exactly what item caused the message.

        • kindstring

        • currentItemCountint32

        • totalItemsint32

        • grossItemsint32

        • itemsPerPageint32

        • startIndexint32

        • pagingLinkTemplatestring

        • pageIndexint32

        • totalPagesint32

        • nextLinkstring

        • previousLinkstring

        • attributesobject

        • items

        • keystring

        • valueobject

        • modulestring

        • isModuleImplementationboolean


          Indicates if the configuration value is a module implementation.
          Module implementations facilitates different behaviour for modules, and may radically change
          behaviour, data model, data store etc for the module.
          You may use this information to customize behaviour of your app.

        • implementationstring


          Indicates what module implementation this parameter works for.

        • aliasesstring

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"priceCalculationDate" : "dateTime","priceListId" : "string","inventoryCheck" : "suspended | active","isLive" : "boolean","authentication" : {"role" : "none | anonymous | customer | salesperson","authentication" : "string","ticket" : "string","ttl" : "int32","customerLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerLoginId" : "int32","userName" : "string","email" : "string","name" : "string","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]},"customer" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]},"salesPersonLogin" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salesPersonLoginId" : "int32","userName" : "string","email" : "string"},"salesPerson" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salespersonId" : "int32","extSalespersonId" : "string","name" : "string","title" : "string","email" : "string","phoneNumber1" : "string","phoneNumber2" : "string","fax" : "string","policies" : "Enabled | ShopFrontAccess"}},"language" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"},"country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"location" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"},"settings" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"key" : "string","value" : "object","module" : "string","isModuleImplementation" : "boolean","implementation" : "string","aliases" : "string"}]}}]}

        apistate

        PUT/sessionservices/v3/apistate

        set context information such as currency, language, country.

        Authentication header is required with one of the following roles: Visitor, Customer, SalesPerson, SalesPersonWithCustomerInContext

        RESPONSE

        Response codes

        Http response Description
        204 NoContent Pushes API V3 state information into server based state, so that you can continue work started in API in a (legacy) eseller web based shop.

        Country

        GET/services/v3/countries

        Authentication header is not allowed.

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • messages

        • severitystringEnum


          The severity of the message.

          Possible values:

          debuginfowarningerrorfatalsecurity

        • messagestring


          Localized message.

        • resultCodestringEnum


          The result code helps you identify what kind of issue the message is about.

          Possible values:

          okwarningnotFoundconstraintFailureunAuthorizedother

        • errorCodestring


          An invariant text string containing identification of the error,
          i.e. a never-changing non-localized text code usable for programmatic handling of the message.

        • kindstring


          Literal reference to what item this message relates to.
          Together with the reference property, this enables you to locate exactly what item was
          the source for this message.

        • referencestring


          Together with kind, this identifies exactly what item caused the message.

        • kindstring

        • currentItemCountint32

        • totalItemsint32

        • grossItemsint32

        • itemsPerPageint32

        • startIndexint32

        • pagingLinkTemplatestring

        • pageIndexint32

        • totalPagesint32

        • nextLinkstring

        • previousLinkstring

        • attributesobject

        • items

        • links

        • rellinkRel


          Specifies what relation this link has to the resource it is declared upon.

        • hrefstring


          Specifies the link to the resource. This would be a relative link.

        • actionlinkAction


          Represents the action suggested to use the resource.

        • titlestring


          The title of the resource, that describes the link.

        • nestedLevelint32


          If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

        • sizeTypeIdint32


          For image resources, this represents the image type of the request.

        • targetContentlinkTargetContent


          An abstract content type describing what kind of data to expect from the resource.

        • targetMediaTypestring


          Describes what media type to expect from the resource in a technical described as mime.

        • countryIdint32

        • extCountryIdstring

        • namestring

        • isDefaultCountryboolean

        • sortOrderint32

        • iso3166Alpha3string

        • iso3166Alpha2string

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"}]}}

        Response codes

        Http response Description
        Returns a list of countries available for shop

        UserValues

        GET/sessionservices/v2/basket/{id}/uservalues

        Gets all user values from the basket with the specified ID

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • idint32REQUIRED

        RESPONSE

        Response fields

        • idstring


          Represents a unique ID for the task carried out by a request.
          The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
          The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
          Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
          The Id is required in Api response.

        • apiVersionstring


          This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

        • contextstring


          Echoes the context from the original request.
          This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

        • servedBystring


          This states a name of the actual server serving the response.
          This has no practical use other but supplying an ensurance of the platform in service.

        • timeServedstring


          Returns the time in UTC when the request was created.

        • appVersionstring


          Returns the application build version.

        • tookdouble


          Returns the complete time it took to process the request.

        • data

        • keystring

        • valuestring

        • isVisibleOnOrderboolean

        • contentTypestring

        • valueTypestring

        Response body

        {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","valueType" : "string"}]}

        Response codes

        Http response Description
        200 OK Everything is fine
        400 BadRequest The request was not understood
        404 NotFound There is no basket context

        UserValues

        POST/sessionservices/v2/basket/{id}/uservalues

        Authentication header is not allowed.

        REQUEST PARAMETERS

        Parameters from Uri

        • idint32REQUIRED

        Parameters from Body

          Request body

          {}

          RESPONSE

          Response fields

          • keystring

          • valuestring

          • isVisibleOnOrderboolean

          • contentTypestring

          • valueTypestring

          Response body

          {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

          Response codes

          Http response Description
          200 OK Everything is fine
          400 BadRequest The request was not understood
          404 NotFound There is no basket context

          UserValues

          DELETE/sessionservices/v2/basket/{id}/uservalues

          Deletes all user values from a basket with specific ID

          Authentication header is not allowed.

          REQUEST PARAMETERS

          Parameters from Uri

          • idint32REQUIRED

          RESPONSE

          Response codes

          Http response Description
          200 OK Everything is fine
          400 BadRequest The request was not understood
          404 NotFound There is no basket context

          UserValues

          GET/sessionservices/v2/basket/{id}/uservalues/{key}

          Gets a user value by specified key from basket with specified ID

          Authentication header is not allowed.

          REQUEST PARAMETERS

          Parameters from Uri

          • idint32REQUIRED

          • keystringREQUIRED

          RESPONSE

          Response fields

          • idstring


            Represents a unique ID for the task carried out by a request.
            The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
            The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
            Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
            The Id is required in Api response.

          • apiVersionstring


            This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

          • contextstring


            Echoes the context from the original request.
            This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

          • servedBystring


            This states a name of the actual server serving the response.
            This has no practical use other but supplying an ensurance of the platform in service.

          • timeServedstring


            Returns the time in UTC when the request was created.

          • appVersionstring


            Returns the application build version.

          • tookdouble


            Returns the complete time it took to process the request.

          • data

          • keystring

          • valuestring

          • isVisibleOnOrderboolean

          • contentTypestring

          • valueTypestring

          Response body

          {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","valueType" : "string"}}

          Response codes

          Http response Description
          200 OK Everything is fine
          400 BadRequest The request was not understood
          404 NotFound There is no basket context

          UserValues

          DELETE/sessionservices/v2/basket/{id}/uservalues/{key}

          Deletes a user value by specified key from current basket

          Authentication header is not allowed.

          REQUEST PARAMETERS

          Parameters from Uri

          • idint32REQUIRED

          • keystringREQUIRED

          RESPONSE

          Response codes

          Http response Description
          200 OK Everything is fine
          400 BadRequest The request was not understood
          404 NotFound There is no basket context

          UserValues

          PUT/sessionservices/v2/basket/{id}/uservalues/{key}

          Updates a user value by specified key from basket with specified ID

          Authentication header is not allowed.

          REQUEST PARAMETERS

          Parameters from Uri

          • idint32REQUIRED

          • keystringREQUIRED

          Parameters from Body

          • keystring

          • valuestring

          • isVisibleOnOrderboolean

          • contentTypestring

          • valueTypestring

          Request body

          {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

          RESPONSE

          Response fields

          • idstring


            Represents a unique ID for the task carried out by a request.
            The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
            The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
            Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
            The Id is required in Api response.

          • apiVersionstring


            This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

          • contextstring


            Echoes the context from the original request.
            This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

          • servedBystring


            This states a name of the actual server serving the response.
            This has no practical use other but supplying an ensurance of the platform in service.

          • timeServedstring


            Returns the time in UTC when the request was created.

          • appVersionstring


            Returns the application build version.

          • tookdouble


            Returns the complete time it took to process the request.

          • data

          • keystring

          • valuestring

          • isVisibleOnOrderboolean

          • contentTypestring

          • valueTypestring

          Response body

          {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","valueType" : "string"}}

          Response codes

          Http response Description
          200 OK Everything is fine
          400 BadRequest The request was not understood
          404 NotFound There is no basket context

          UserValues

          GET/sessionservices/v2/basket/current/uservalues

          Gets all user values from current basket

          Authentication header is not allowed.

          RESPONSE

          Response fields

          • idstring


            Represents a unique ID for the task carried out by a request.
            The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
            The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
            Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
            The Id is required in Api response.

          • apiVersionstring


            This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

          • contextstring


            Echoes the context from the original request.
            This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

          • servedBystring


            This states a name of the actual server serving the response.
            This has no practical use other but supplying an ensurance of the platform in service.

          • timeServedstring


            Returns the time in UTC when the request was created.

          • appVersionstring


            Returns the application build version.

          • tookdouble


            Returns the complete time it took to process the request.

          • data

          • keystring

          • valuestring

          • isVisibleOnOrderboolean

          • contentTypestring

          • valueTypestring

          Response body

          {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","valueType" : "string"}]}

          Response codes

          Http response Description
          200 OK Everything is fine
          400 BadRequest The request was not understood
          404 NotFound There is no basket context

          UserValues

          POST/sessionservices/v2/basket/current/uservalues

          Authentication header is not allowed.

          REQUEST PARAMETERS

          Parameters from Body

            Request body

            {}

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","valueType" : "string"}}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            DELETE/sessionservices/v2/basket/current/uservalues

            Deletes all user values from current basket

            Authentication header is not allowed.

            RESPONSE

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            GET/sessionservices/v2/basket/current/uservalues/{key}

            Gets a user value by specified key from current basket

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • keystringREQUIRED

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"key" : "string","value" : "string","isVisibleOnOrder" : "boolean","contentType" : "string","valueType" : "string"}}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            DELETE/sessionservices/v2/basket/current/uservalues/{key}

            Deletes a user value by specified key from current basket

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • keystringREQUIRED

            RESPONSE

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            GET/sessionservices/v1/basket/{id}/uservalues

            Gets all user values from the basket with the specified ID

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • idint32REQUIRED

            RESPONSE

            Response fields

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            POST/sessionservices/v1/basket/{id}/uservalues

            Creates or updates a user value to a basket with specified ID

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • idint32REQUIRED

            Parameters from Body

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Request body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            RESPONSE

            Response fields

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            DELETE/sessionservices/v1/basket/{id}/uservalues

            Deletes all user values from a basket with specific ID

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • idint32REQUIRED

            RESPONSE

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            GET/sessionservices/v1/basket/{id}/uservalues/{key}

            Gets a user value by specified key from basket with specified ID

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • idint32REQUIRED

            • keystringREQUIRED

            RESPONSE

            Response fields

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            DELETE/sessionservices/v1/basket/{id}/uservalues/{key}

            Deletes a user value by specified key from current basket

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • idint32REQUIRED

            • keystringREQUIRED

            RESPONSE

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            PUT/sessionservices/v1/basket/{id}/uservalues/{key}

            Updates a user value by specified key from basket with specified ID

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • idint32REQUIRED

            • keystringREQUIRED

            Parameters from Body

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Request body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            RESPONSE

            Response fields

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            GET/sessionservices/v1/basket/current/uservalues

            Gets all user values from current basket

            Authentication header is not allowed.

            RESPONSE

            Response fields

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            POST/sessionservices/v1/basket/current/uservalues

            Creates or updates a user value to current basket

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Body

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Request body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            RESPONSE

            Response fields

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            DELETE/sessionservices/v1/basket/current/uservalues

            Deletes all user values from current basket

            Authentication header is not allowed.

            RESPONSE

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            GET/sessionservices/v1/basket/current/uservalues/{key}

            Gets a user value by specified key from current basket

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • keystringREQUIRED

            RESPONSE

            Response fields

            • keystring

            • valuestring

            • isVisibleOnOrderboolean

            • contentTypestring

            • valueTypestring

            Response body

            {
"key" : "string",
"value" : "string",
"isVisibleOnOrder" : "boolean",
"contentType" : "string",
"valueType" : "string"}

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            UserValues

            DELETE/sessionservices/v1/basket/current/uservalues/{key}

            Deletes a user value by specified key from current basket

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • keystringREQUIRED

            RESPONSE

            Response codes

            Http response Description
            200 OK Everything is fine
            400 BadRequest The request was not understood
            404 NotFound There is no basket context

            ImageSizeType

            GET/services/v3/imagesizetypes

            Returns available imagesizetypes for the 'current' shop/layout

            Authentication header is not allowed.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • items

            • imageSizeTypeIdint32

            • namestring

            • maxWidthint32

            • maxHeightint32

            • qualityint32

            • tagsstring

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"imageSizeTypeId" : "int32","name" : "string","maxWidth" : "int32","maxHeight" : "int32","quality" : "int32","tags" : "string"}]}}

            Manufacturers

            GET/services/v3/manufacturers

            Returns a list of manufacturers

            Authentication header is not allowed.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • items

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • manufacturerIDint32

            • manufacturerNamestring

            • manufacturerLinkstring

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"manufacturerID" : "int32","manufacturerName" : "string","manufacturerLink" : "string"}]}}

            Media

            GET/services/v3/media

            Authentication header is not allowed.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • resourceNamestring

            • resourceTypestring

            • contentTypestring

            • lastUpdatedstring

            • fileSizestring

            • resourceUrlstring

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"resourceName" : "string","resourceType" : "string","contentType" : "string","lastUpdated" : "string","fileSize" : "string","resourceUrl" : "string"}]}

            Media

            GET/services/v3/media/{name}

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • namestringREQUIRED

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • resourceNamestring

            • resourceTypestring

            • contentTypestring

            • lastUpdatedstring

            • fileSizestring

            • resourceUrlstring

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"resourceName" : "string","resourceType" : "string","contentType" : "string","lastUpdated" : "string","fileSize" : "string","resourceUrl" : "string"}]}

            Currencies

            GET/services/v3/currencies

            List currencies.

            Authentication header is not allowed.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • items

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • currencyIdint32

            • extCurrencyIdstring

            • displayNamestring

            • uISortOrderint32

            • namestring

            • iso4217Alpha3string

            • iso4217Numericint32

            • decimalSeparatorstring

            • decimalDigitsint32

            • decimalGroupSeparatorstring

            • groupSizeint32

            • positivePatternint32

            • negativePatternint32

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"}]}}

            Response codes

            Http response Description
            Returns a list of currencies available against Shop group and account

            Product

            GET/services/v3/products/{productId}/images/{imageId}/stream/{imageSizeTypeId}?rev={rev}

            Returns a http stream for the image.

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • productIdint32REQUIRED

            • imageIdint32REQUIRED

            • imageSizeTypeIdint32REQUIRED

            • revstring

            Product

            GET/services/v3/products/{productId}/productmenus

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • productIdint32REQUIRED

            • strict=true

              Will limit the selected data to only one menuKind, f.inst productMenu.

            • include=description

              Includes SubTitle property.
              Includes Description property.
              Includes Description2 property.
              Includes SeoHtmlTitle property.
              Includes SeoMetaDescription property.
              Includes SeoMetaKeywords property.
              Includes LayoutText property.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • items

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • menuKeymenuKey


              Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

            • menuIdint32

            • menuKindstringEnum

              Possible values:

              PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

            • parentMenuKeymenuKey

            • menuIdint32

            • menuKindstringEnum

              Possible values:

              PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

            • extMenuItemIdstring

            • bookmarkstring

            • sortOrderint32

            • navigateUrlstring

            • navigateTargetstring

            • pageFlowIdint32

            • pageFlowSortOrderint32

            • isPrimaryMenuboolean

            • rootEntrystringEnum

              Possible values:

              pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

            • lifeTimeIdstring

            • namestring

            • subTitlestring

            • descriptionstring

            • description2string

            • seoHtmlTitlestring

            • seoMetaDescriptionstring

            • seoMetaKeywordsstring

            • layoutTextstring

            • roots

            • entrystringEnum


              Informs what kind of content is expected in nodes of a branch. The TreeBranchContent are generally mapped to specific view(s) of the information presented its nodes, i.e. info page, product listing etc. />

              Possible values:

              pageinfomenu1infomenu2infomenu3infomenu4topmenubottommenufaqproductmenusearchresultcustomerfavorites

            • menuKeymenuKey


              Forms a natural key for menues within eSeller, combining referencing menu id and the menu kind id into a single structure.

            • menuIdint32

            • menuKindstringEnum

              Possible values:

              PageProductMenuInfoMenuInfoMenu1InfoMenu2InfoMenu3InfoMenu4topmenubottommenufaq

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : [{"items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"parentMenuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"},"extMenuItemId" : "string","bookmark" : "string","sortOrder" : "int32","navigateUrl" : "string","navigateTarget" : "string","pageFlowId" : "int32","pageFlowSortOrder" : "int32","isPrimaryMenu" : "boolean","rootEntry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","lifeTimeId" : "string","name" : "string","subTitle" : "string","description" : "string","description2" : "string","seoHtmlTitle" : "string","seoMetaDescription" : "string","seoMetaKeywords" : "string","layoutText" : "string"}],"roots" : [{"entry" : "page | infomenu1 | infomenu2 | infomenu3 | infomenu4 | topmenu | bottommenu | faq | productmenu | searchresult | customerfavorites","menuKey" : {"menuId" : "int32","menuKind" : "Page | ProductMenu | InfoMenu | InfoMenu1 | InfoMenu2 | InfoMenu3 | InfoMenu4 | topmenu | bottommenu | faq"}}]}]}

            Product

            GET/services/v3/products/{productId}/relatedproducts?tag={tag}

            Returns a product list of related products.

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • productIdint32REQUIRED

            • tagstring

            • include=shortdesc

              Causes item short description to be rendered

            • include=shortdescrecurse

              same as shortdesc, but also renders item short description for child items in f.inst bom products.

            • include=longdesc

              Causes item long description to be rendered

            • include=longdescrecurse

              same as longdesc, but also renders item long description for child items in f.inst bom products.

            • include=seo

              SeoMetaTagKeywords is rendered
              SeoHtmlTitle is rendered
              SeoMetaTagDescription is rendered

            • include=inventory

              Show exact inventory

            • include=locations

              show the product locations

            Parameters from Query

            • tag

              Only list related products with the specified tag. If tag is not specified, only related products without tags are listed.

            • filterFields

              A comma separated list of ids of filterable properterties (customfields) that should be listed in filterFields section of the output. If not provided, all fields will be listed.

            • sort

              A comma separated list of sort specifications. A sort specification is made up of three parts, separated by colon: part:name:order. Example: sort=p:name:asc,c:mycustomfield:desc. If no sort is specified, default sorting will be used.

            • fn<n>,fk<n>,fv<n>

              Parameters used to specify filters for the list.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • items

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • variantDimensions

            • namestring

            • values

            • isInItemsboolean

            • namestring

            • indexint32

            • filterFields

            • kindstringEnum

              Possible values:

              productPropertycustomFieldvariantproductPrice

            • filterFieldIdint64

            • extFilterFieldIdstring

            • namestring

            • typestringEnum

              Possible values:

              customstringintegerdecimal

            • isAppliedboolean

            • upperBounddecimal


              If field is a number type, marks the upper bound value for items in the result.

            • lowerBounddecimal


              If field is a number type, marks the lower bound value for items in the result.

            • upperGrossBounddecimal


              If field is a number type, marks the upper bound value for items in the un-filtered result.

            • lowerGrossBounddecimal


              If field is a number type, marks the lower bound value for items in the un-filtered result.

            • values

            • nativeValuestring

            • valuestring

            • countint32


              How many items within the result has this value.

            • isAppliedboolean

            • sortOrderint32

            • productMenus

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • extMenuItemIdstring

            • menuItemIdint32

            • descriptionstring

            • alternateDescriptionstring

            • uiSortOrderint32

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • articles

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • uiSortOrderint32

            • descriptionstring

            • metaData


              Meta data and settings for rendering this list.

            • showProductIdboolean

            • showProductEanboolean

            • showProductManufacturerSkuboolean

            • showExtProductIdboolean

            • showAltExtProductIdboolean

            • enableAddToBasketboolean

            • unitOfMeasures

            • unitOfMeasureIdint32

            • extUnitOfMeasureIdstring

            • abbreviationstring


              Short notation of the unit. Try using abbreviations familiar to your clients.

            • siUnitstringEnum


              Indicates if the unit is a standardized unit (f.inst kilo) or non-standardized unit (f.inst box or pallet)

              Lists the 7 fundamental unit of measures based on the International System of Units (SI). See https://en.wikipedia.org/wiki/SI_base_unit .
              An additional 8th unit ia added to describe abstract business specific units, like "each" or "box", that does not translate very well to an SI unit.
              This enumeration is used to describe physical and/or logistical aspects of an .

              Possible values:

              nonSiUnitlengthmasstimeelectricCurrentthermoDynamicTemperatureamountOfSubstanceluminousIntensity

            • conversionFactordecimal


              Indicates how this unit mathematical relates to its base unit.
              Base units will have conversion factor 1.

            • baseUnitOfMeasureIdint32


              If this unit relates to another unit. All units with the same base can be converted between each other.

            • descriptionstring


              A more elaborate description of this unit. Try using terms familiar to your clients.

            • items

            • itemVersionstring

            • extVariantIdstring

            • extItemIdstring

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • namestring

            • shortDescriptionstring

            • longDescriptionstring

            • seoMetaTagKeywordsstring

            • seoHtmlTitlestring

            • seoMetaTagDescriptionstring

            • scoredouble

            • variantNamestring

            • variantValuesstring

            • hasVariantsboolean

            • hasSalesPriceboolean

            • showSalesPriceboolean

            • frontPageProductboolean

            • greatBuyboolean

            • noveltyProductboolean

            • deprecatedboolean

            • manufacturerIdint32

            • manufacturerstring

            • manufacturerSkustring

            • hasExpectedDeliveryDateboolean

            • expectedDeliveryDatedateTime

            • shipmentsstring

            • isBuyableboolean

            • isConfiguredProductboolean

            • showAddToBasketboolean

            • showAddToFavoritesboolean

            • boundToInventoryCountboolean

            • stocklevelint32

            • locations

            • locationIdint64

            • extLocationIdstring

            • isBuyableboolean

            • isVisibleInShopboolean

            • stocklevelint32

            • boundToInventoryCountboolean

            • stockAvailabilitystring

            • grossWeight


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnit

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnitConstraints

            • extSalesUnitConstraintIdstring

            • smallestCountdecimal


              Indicates least common multiple in which that this item can be bought. Quantity bought must be a multiple of this value.
              F.inst if your unit is kilo, 1 indicates you buy in chunks of kilos, 0.5 indicates you buy in chunks of half-kilos (note: scale would then be 1 to allow for a decimal)

            • minimumCountdecimal


              Indicates the minimum number of units clients are required to buy.

            • maximumCountdecimal

            • scaleint32


              Indicates how many decimal places should be shown and accepted for the related unit. this would typically be 1 (one) if buying in chunks of whole units.

            • stockAvailabilitystring

            • salesPrices

            • amount


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • beforePrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • recommendedPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • salesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • totalSalesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • descriptionstring

            • discountLabelstring

            • salesPriceLabelstring

            • validFromdateTime


              Date and time in UTC, from when this price takes effect.

            • validTodateTime


              Date and time in UTC when this price is no longer valid.

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • customFields

            • customFieldIdint64

            • extCustomFieldIdstring

            • valuestring

            • namestring

            • nativeValuestring

            • variants

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • suggestedQuantitydecimal

            • eanstring

            • annotationobject

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"id" : "string","apiVersion" : "string","context" : "string","servedBy" : "string","timeServed" : "string","appVersion" : "string","took" : "double","data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","variantDimensions" : [{"name" : "string","values" : [{"isInItems" : "boolean","name" : "string"}],"index" : "int32"}],"filterFields" : [{"kind" : "productProperty | customField | variant | productPrice","filterFieldId" : "int64","extFilterFieldId" : "string","name" : "string","type" : "custom | string | integer | decimal","isApplied" : "boolean","upperBound" : "decimal","lowerBound" : "decimal","upperGrossBound" : "decimal","lowerGrossBound" : "decimal","values" : [{"nativeValue" : "string","value" : "string","count" : "int32","isApplied" : "boolean","sortOrder" : "int32"}]}],"productMenus" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","extMenuItemId" : "string","menuItemId" : "int32","description" : "string","alternateDescription" : "string","uiSortOrder" : "int32","links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}]}],"articles" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","uiSortOrder" : "int32","description" : "string"}],"metaData" : {"showProductId" : "boolean","showProductEan" : "boolean","showProductManufacturerSku" : "boolean","showExtProductId" : "boolean","showAltExtProductId" : "boolean","enableAddToBasket" : "boolean"},"unitOfMeasures" : [{"unitOfMeasureId" : "int32","extUnitOfMeasureId" : "string","abbreviation" : "string","siUnit" : "nonSiUnit | length | mass | time | electricCurrent | thermoDynamicTemperature | amountOfSubstance | luminousIntensity","conversionFactor" : "decimal","baseUnitOfMeasureId" : "int32","description" : "string"}],"items" : [{"itemVersion" : "string","extVariantId" : "string","extItemId" : "string","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"name" : "string","shortDescription" : "string","longDescription" : "string","seoMetaTagKeywords" : "string","seoHtmlTitle" : "string","seoMetaTagDescription" : "string","score" : "double","variantName" : "string","variantValues" : "string","hasVariants" : "boolean","hasSalesPrice" : "boolean","showSalesPrice" : "boolean","frontPageProduct" : "boolean","greatBuy" : "boolean","noveltyProduct" : "boolean","deprecated" : "boolean","manufacturerId" : "int32","manufacturer" : "string","manufacturerSku" : "string","hasExpectedDeliveryDate" : "boolean","expectedDeliveryDate" : "dateTime","shipments" : "string","isBuyable" : "boolean","isConfiguredProduct" : "boolean","showAddToBasket" : "boolean","showAddToFavorites" : "boolean","boundToInventoryCount" : "boolean","stocklevel" : "int32","locations" : [{"locationId" : "int64","extLocationId" : "string","isBuyable" : "boolean","isVisibleInShop" : "boolean","stocklevel" : "int32","boundToInventoryCount" : "boolean","stockAvailability" : "string"}],"grossWeight" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"salesUnit" : [{"unitOfMeasureId" : "int32","abbreviation" : "string"}],"salesUnitConstraints" : [{"extSalesUnitConstraintId" : "string","smallestCount" : "decimal","minimumCount" : "decimal","maximumCount" : "decimal","scale" : "int32"}],"stockAvailability" : "string","salesPrices" : [{"amount" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"beforePrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"recommendedPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"salesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"totalSalesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"description" : "string","discountLabel" : "string","salesPriceLabel" : "string","validFrom" : "dateTime","validTo" : "dateTime"}],"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customFields" : [{"customFieldId" : "int64","extCustomFieldId" : "string","value" : "string","name" : "string","nativeValue" : "string"}],"variants" : [{"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"}}],"suggestedQuantity" : "decimal","ean" : "string","annotation" : "object"}]}}]}}

            Product

            GET/services/v3/products/list

            Returns a product list and meta data structures.

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • include=shortdesc

              Causes item short description to be rendered

            • include=shortdescrecurse

              same as shortdesc, but also renders item short description for child items in f.inst bom products.

            • include=longdesc

              Causes item long description to be rendered

            • include=longdescrecurse

              same as longdesc, but also renders item long description for child items in f.inst bom products.

            • include=seo

              SeoMetaTagKeywords is rendered
              SeoHtmlTitle is rendered
              SeoMetaTagDescription is rendered

            • include=inventory

              Show exact inventory

            • include=locations

              show the product locations

            Parameters from Query

            • search

              This parameter turns the request into a smart search, where items are qualified by the search text.

            • mId

              Limits the resulting list to items on the specified menu.

            • filterFields

              A comma separated list of ids of filterable properterties (customfields) that should be listed in filterFields section of the output. If not provided, all fields will be listed.

            • sort

              A comma-separated list of sort specifications. A sort specification is made up of three parts, separated by colon: part:name:order. Example: sort=p:name:asc,c:mycustomfield:desc. If no sort is specified, default sorting will be used. It is possible to sort by "name", "extitemid", "sort" (sort order number specified on product), "ean" and "salesprice" - must be prefixed with "p:" and by any custom field - must be prefixed with "c:".

            • fn<n>,fk<n>,fv<n>

              Parameters used to specify filters for the list.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • variantDimensions

            • namestring

            • values

            • isInItemsboolean

            • namestring

            • indexint32

            • filterFields

            • kindstringEnum

              Possible values:

              productPropertycustomFieldvariantproductPrice

            • filterFieldIdint64

            • extFilterFieldIdstring

            • namestring

            • typestringEnum

              Possible values:

              customstringintegerdecimal

            • isAppliedboolean

            • upperBounddecimal


              If field is a number type, marks the upper bound value for items in the result.

            • lowerBounddecimal


              If field is a number type, marks the lower bound value for items in the result.

            • upperGrossBounddecimal


              If field is a number type, marks the upper bound value for items in the un-filtered result.

            • lowerGrossBounddecimal


              If field is a number type, marks the lower bound value for items in the un-filtered result.

            • values

            • nativeValuestring

            • valuestring

            • countint32


              How many items within the result has this value.

            • isAppliedboolean

            • sortOrderint32

            • productMenus

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • extMenuItemIdstring

            • menuItemIdint32

            • descriptionstring

            • alternateDescriptionstring

            • uiSortOrderint32

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • articles

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • uiSortOrderint32

            • descriptionstring

            • metaData


              Meta data and settings for rendering this list.

            • showProductIdboolean

            • showProductEanboolean

            • showProductManufacturerSkuboolean

            • showExtProductIdboolean

            • showAltExtProductIdboolean

            • enableAddToBasketboolean

            • unitOfMeasures

            • unitOfMeasureIdint32

            • extUnitOfMeasureIdstring

            • abbreviationstring


              Short notation of the unit. Try using abbreviations familiar to your clients.

            • siUnitstringEnum


              Indicates if the unit is a standardized unit (f.inst kilo) or non-standardized unit (f.inst box or pallet)

              Lists the 7 fundamental unit of measures based on the International System of Units (SI). See https://en.wikipedia.org/wiki/SI_base_unit .
              An additional 8th unit ia added to describe abstract business specific units, like "each" or "box", that does not translate very well to an SI unit.
              This enumeration is used to describe physical and/or logistical aspects of an .

              Possible values:

              nonSiUnitlengthmasstimeelectricCurrentthermoDynamicTemperatureamountOfSubstanceluminousIntensity

            • conversionFactordecimal


              Indicates how this unit mathematical relates to its base unit.
              Base units will have conversion factor 1.

            • baseUnitOfMeasureIdint32


              If this unit relates to another unit. All units with the same base can be converted between each other.

            • descriptionstring


              A more elaborate description of this unit. Try using terms familiar to your clients.

            • items

            • itemVersionstring

            • extVariantIdstring

            • extItemIdstring

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • namestring

            • shortDescriptionstring

            • longDescriptionstring

            • seoMetaTagKeywordsstring

            • seoHtmlTitlestring

            • seoMetaTagDescriptionstring

            • scoredouble

            • variantNamestring

            • variantValuesstring

            • hasVariantsboolean

            • hasSalesPriceboolean

            • showSalesPriceboolean

            • frontPageProductboolean

            • greatBuyboolean

            • noveltyProductboolean

            • deprecatedboolean

            • manufacturerIdint32

            • manufacturerstring

            • manufacturerSkustring

            • hasExpectedDeliveryDateboolean

            • expectedDeliveryDatedateTime

            • shipmentsstring

            • isBuyableboolean

            • isConfiguredProductboolean

            • showAddToBasketboolean

            • showAddToFavoritesboolean

            • boundToInventoryCountboolean

            • stocklevelint32

            • locations

            • locationIdint64

            • extLocationIdstring

            • isBuyableboolean

            • isVisibleInShopboolean

            • stocklevelint32

            • boundToInventoryCountboolean

            • stockAvailabilitystring

            • grossWeight


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnit

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnitConstraints

            • extSalesUnitConstraintIdstring

            • smallestCountdecimal


              Indicates least common multiple in which that this item can be bought. Quantity bought must be a multiple of this value.
              F.inst if your unit is kilo, 1 indicates you buy in chunks of kilos, 0.5 indicates you buy in chunks of half-kilos (note: scale would then be 1 to allow for a decimal)

            • minimumCountdecimal


              Indicates the minimum number of units clients are required to buy.

            • maximumCountdecimal

            • scaleint32


              Indicates how many decimal places should be shown and accepted for the related unit. this would typically be 1 (one) if buying in chunks of whole units.

            • stockAvailabilitystring

            • salesPrices

            • amount


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • beforePrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • recommendedPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • salesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • totalSalesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • descriptionstring

            • discountLabelstring

            • salesPriceLabelstring

            • validFromdateTime


              Date and time in UTC, from when this price takes effect.

            • validTodateTime


              Date and time in UTC when this price is no longer valid.

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • customFields

            • customFieldIdint64

            • extCustomFieldIdstring

            • valuestring

            • namestring

            • nativeValuestring

            • variants

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • suggestedQuantitydecimal

            • eanstring

            • annotationobject

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","variantDimensions" : [{"name" : "string","values" : [{"isInItems" : "boolean","name" : "string"}],"index" : "int32"}],"filterFields" : [{"kind" : "productProperty | customField | variant | productPrice","filterFieldId" : "int64","extFilterFieldId" : "string","name" : "string","type" : "custom | string | integer | decimal","isApplied" : "boolean","upperBound" : "decimal","lowerBound" : "decimal","upperGrossBound" : "decimal","lowerGrossBound" : "decimal","values" : [{"nativeValue" : "string","value" : "string","count" : "int32","isApplied" : "boolean","sortOrder" : "int32"}]}],"productMenus" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","extMenuItemId" : "string","menuItemId" : "int32","description" : "string","alternateDescription" : "string","uiSortOrder" : "int32","links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}]}],"articles" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","uiSortOrder" : "int32","description" : "string"}],"metaData" : {"showProductId" : "boolean","showProductEan" : "boolean","showProductManufacturerSku" : "boolean","showExtProductId" : "boolean","showAltExtProductId" : "boolean","enableAddToBasket" : "boolean"},"unitOfMeasures" : [{"unitOfMeasureId" : "int32","extUnitOfMeasureId" : "string","abbreviation" : "string","siUnit" : "nonSiUnit | length | mass | time | electricCurrent | thermoDynamicTemperature | amountOfSubstance | luminousIntensity","conversionFactor" : "decimal","baseUnitOfMeasureId" : "int32","description" : "string"}],"items" : [{"itemVersion" : "string","extVariantId" : "string","extItemId" : "string","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"name" : "string","shortDescription" : "string","longDescription" : "string","seoMetaTagKeywords" : "string","seoHtmlTitle" : "string","seoMetaTagDescription" : "string","score" : "double","variantName" : "string","variantValues" : "string","hasVariants" : "boolean","hasSalesPrice" : "boolean","showSalesPrice" : "boolean","frontPageProduct" : "boolean","greatBuy" : "boolean","noveltyProduct" : "boolean","deprecated" : "boolean","manufacturerId" : "int32","manufacturer" : "string","manufacturerSku" : "string","hasExpectedDeliveryDate" : "boolean","expectedDeliveryDate" : "dateTime","shipments" : "string","isBuyable" : "boolean","isConfiguredProduct" : "boolean","showAddToBasket" : "boolean","showAddToFavorites" : "boolean","boundToInventoryCount" : "boolean","stocklevel" : "int32","locations" : [{"locationId" : "int64","extLocationId" : "string","isBuyable" : "boolean","isVisibleInShop" : "boolean","stocklevel" : "int32","boundToInventoryCount" : "boolean","stockAvailability" : "string"}],"grossWeight" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"salesUnit" : [{"unitOfMeasureId" : "int32","abbreviation" : "string"}],"salesUnitConstraints" : [{"extSalesUnitConstraintId" : "string","smallestCount" : "decimal","minimumCount" : "decimal","maximumCount" : "decimal","scale" : "int32"}],"stockAvailability" : "string","salesPrices" : [{"amount" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"beforePrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"recommendedPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"salesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"totalSalesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"description" : "string","discountLabel" : "string","salesPriceLabel" : "string","validFrom" : "dateTime","validTo" : "dateTime"}],"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customFields" : [{"customFieldId" : "int64","extCustomFieldId" : "string","value" : "string","name" : "string","nativeValue" : "string"}],"variants" : [{"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"}}],"suggestedQuantity" : "decimal","ean" : "string","annotation" : "object"}]}}

            Product

            GET/services/v3/products?extItemKeys={extItemKeys}

            Returns multiple products identifier by a json formatted array of item keys using external id, i.e. [{"itemId":"E6536309","typeOfItem":"product"}]

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • extItemKeysstringREQUIRED

            • include=shortdesc

              Causes item short description to be rendered

            • include=shortdescrecurse

              same as shortdesc, but also renders item short description for child items in f.inst bom products.

            • include=longdesc

              Causes item long description to be rendered

            • include=longdescrecurse

              same as longdesc, but also renders item long description for child items in f.inst bom products.

            • include=seo

              SeoMetaTagKeywords is rendered
              SeoHtmlTitle is rendered
              SeoMetaTagDescription is rendered

            • include=inventory

              Show exact inventory

            • include=locations

              show the product locations

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • items

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • variantDimensions

            • namestring

            • values

            • isInItemsboolean

            • namestring

            • indexint32

            • filterFields

            • kindstringEnum

              Possible values:

              productPropertycustomFieldvariantproductPrice

            • filterFieldIdint64

            • extFilterFieldIdstring

            • namestring

            • typestringEnum

              Possible values:

              customstringintegerdecimal

            • isAppliedboolean

            • upperBounddecimal


              If field is a number type, marks the upper bound value for items in the result.

            • lowerBounddecimal


              If field is a number type, marks the lower bound value for items in the result.

            • upperGrossBounddecimal


              If field is a number type, marks the upper bound value for items in the un-filtered result.

            • lowerGrossBounddecimal


              If field is a number type, marks the lower bound value for items in the un-filtered result.

            • values

            • nativeValuestring

            • valuestring

            • countint32


              How many items within the result has this value.

            • isAppliedboolean

            • sortOrderint32

            • productMenus

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • extMenuItemIdstring

            • menuItemIdint32

            • descriptionstring

            • alternateDescriptionstring

            • uiSortOrderint32

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • articles

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • uiSortOrderint32

            • descriptionstring

            • metaData


              Meta data and settings for rendering this list.

            • showProductIdboolean

            • showProductEanboolean

            • showProductManufacturerSkuboolean

            • showExtProductIdboolean

            • showAltExtProductIdboolean

            • enableAddToBasketboolean

            • unitOfMeasures

            • unitOfMeasureIdint32

            • extUnitOfMeasureIdstring

            • abbreviationstring


              Short notation of the unit. Try using abbreviations familiar to your clients.

            • siUnitstringEnum


              Indicates if the unit is a standardized unit (f.inst kilo) or non-standardized unit (f.inst box or pallet)

              Lists the 7 fundamental unit of measures based on the International System of Units (SI). See https://en.wikipedia.org/wiki/SI_base_unit .
              An additional 8th unit ia added to describe abstract business specific units, like "each" or "box", that does not translate very well to an SI unit.
              This enumeration is used to describe physical and/or logistical aspects of an .

              Possible values:

              nonSiUnitlengthmasstimeelectricCurrentthermoDynamicTemperatureamountOfSubstanceluminousIntensity

            • conversionFactordecimal


              Indicates how this unit mathematical relates to its base unit.
              Base units will have conversion factor 1.

            • baseUnitOfMeasureIdint32


              If this unit relates to another unit. All units with the same base can be converted between each other.

            • descriptionstring


              A more elaborate description of this unit. Try using terms familiar to your clients.

            • items

            • itemVersionstring

            • extVariantIdstring

            • extItemIdstring

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • namestring

            • shortDescriptionstring

            • longDescriptionstring

            • seoMetaTagKeywordsstring

            • seoHtmlTitlestring

            • seoMetaTagDescriptionstring

            • scoredouble

            • variantNamestring

            • variantValuesstring

            • hasVariantsboolean

            • hasSalesPriceboolean

            • showSalesPriceboolean

            • frontPageProductboolean

            • greatBuyboolean

            • noveltyProductboolean

            • deprecatedboolean

            • manufacturerIdint32

            • manufacturerstring

            • manufacturerSkustring

            • hasExpectedDeliveryDateboolean

            • expectedDeliveryDatedateTime

            • shipmentsstring

            • isBuyableboolean

            • isConfiguredProductboolean

            • showAddToBasketboolean

            • showAddToFavoritesboolean

            • boundToInventoryCountboolean

            • stocklevelint32

            • locations

            • locationIdint64

            • extLocationIdstring

            • isBuyableboolean

            • isVisibleInShopboolean

            • stocklevelint32

            • boundToInventoryCountboolean

            • stockAvailabilitystring

            • grossWeight


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnit

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnitConstraints

            • extSalesUnitConstraintIdstring

            • smallestCountdecimal


              Indicates least common multiple in which that this item can be bought. Quantity bought must be a multiple of this value.
              F.inst if your unit is kilo, 1 indicates you buy in chunks of kilos, 0.5 indicates you buy in chunks of half-kilos (note: scale would then be 1 to allow for a decimal)

            • minimumCountdecimal


              Indicates the minimum number of units clients are required to buy.

            • maximumCountdecimal

            • scaleint32


              Indicates how many decimal places should be shown and accepted for the related unit. this would typically be 1 (one) if buying in chunks of whole units.

            • stockAvailabilitystring

            • salesPrices

            • amount


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • beforePrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • recommendedPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • salesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • totalSalesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • descriptionstring

            • discountLabelstring

            • salesPriceLabelstring

            • validFromdateTime


              Date and time in UTC, from when this price takes effect.

            • validTodateTime


              Date and time in UTC when this price is no longer valid.

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • customFields

            • customFieldIdint64

            • extCustomFieldIdstring

            • valuestring

            • namestring

            • nativeValuestring

            • variants

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • suggestedQuantitydecimal

            • eanstring

            • annotationobject

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"id" : "string","apiVersion" : "string","context" : "string","servedBy" : "string","timeServed" : "string","appVersion" : "string","took" : "double","data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","variantDimensions" : [{"name" : "string","values" : [{"isInItems" : "boolean","name" : "string"}],"index" : "int32"}],"filterFields" : [{"kind" : "productProperty | customField | variant | productPrice","filterFieldId" : "int64","extFilterFieldId" : "string","name" : "string","type" : "custom | string | integer | decimal","isApplied" : "boolean","upperBound" : "decimal","lowerBound" : "decimal","upperGrossBound" : "decimal","lowerGrossBound" : "decimal","values" : [{"nativeValue" : "string","value" : "string","count" : "int32","isApplied" : "boolean","sortOrder" : "int32"}]}],"productMenus" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","extMenuItemId" : "string","menuItemId" : "int32","description" : "string","alternateDescription" : "string","uiSortOrder" : "int32","links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}]}],"articles" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","uiSortOrder" : "int32","description" : "string"}],"metaData" : {"showProductId" : "boolean","showProductEan" : "boolean","showProductManufacturerSku" : "boolean","showExtProductId" : "boolean","showAltExtProductId" : "boolean","enableAddToBasket" : "boolean"},"unitOfMeasures" : [{"unitOfMeasureId" : "int32","extUnitOfMeasureId" : "string","abbreviation" : "string","siUnit" : "nonSiUnit | length | mass | time | electricCurrent | thermoDynamicTemperature | amountOfSubstance | luminousIntensity","conversionFactor" : "decimal","baseUnitOfMeasureId" : "int32","description" : "string"}],"items" : [{"itemVersion" : "string","extVariantId" : "string","extItemId" : "string","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"name" : "string","shortDescription" : "string","longDescription" : "string","seoMetaTagKeywords" : "string","seoHtmlTitle" : "string","seoMetaTagDescription" : "string","score" : "double","variantName" : "string","variantValues" : "string","hasVariants" : "boolean","hasSalesPrice" : "boolean","showSalesPrice" : "boolean","frontPageProduct" : "boolean","greatBuy" : "boolean","noveltyProduct" : "boolean","deprecated" : "boolean","manufacturerId" : "int32","manufacturer" : "string","manufacturerSku" : "string","hasExpectedDeliveryDate" : "boolean","expectedDeliveryDate" : "dateTime","shipments" : "string","isBuyable" : "boolean","isConfiguredProduct" : "boolean","showAddToBasket" : "boolean","showAddToFavorites" : "boolean","boundToInventoryCount" : "boolean","stocklevel" : "int32","locations" : [{"locationId" : "int64","extLocationId" : "string","isBuyable" : "boolean","isVisibleInShop" : "boolean","stocklevel" : "int32","boundToInventoryCount" : "boolean","stockAvailability" : "string"}],"grossWeight" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"salesUnit" : [{"unitOfMeasureId" : "int32","abbreviation" : "string"}],"salesUnitConstraints" : [{"extSalesUnitConstraintId" : "string","smallestCount" : "decimal","minimumCount" : "decimal","maximumCount" : "decimal","scale" : "int32"}],"stockAvailability" : "string","salesPrices" : [{"amount" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"beforePrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"recommendedPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"salesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"totalSalesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"description" : "string","discountLabel" : "string","salesPriceLabel" : "string","validFrom" : "dateTime","validTo" : "dateTime"}],"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customFields" : [{"customFieldId" : "int64","extCustomFieldId" : "string","value" : "string","name" : "string","nativeValue" : "string"}],"variants" : [{"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"}}],"suggestedQuantity" : "decimal","ean" : "string","annotation" : "object"}]}}]}}

            Product

            GET/services/v3/products?itemKeys={itemKeys}

            Returns multiple products identifier by a json formatted array of item keys, i.e. [{"itemId":6536309,"typeOfItem":"product"}]

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Uri

            • itemKeysstringREQUIRED

            • include=shortdesc

              Causes item short description to be rendered

            • include=shortdescrecurse

              same as shortdesc, but also renders item short description for child items in f.inst bom products.

            • include=longdesc

              Causes item long description to be rendered

            • include=longdescrecurse

              same as longdesc, but also renders item long description for child items in f.inst bom products.

            • include=seo

              SeoMetaTagKeywords is rendered
              SeoHtmlTitle is rendered
              SeoMetaTagDescription is rendered

            • include=inventory

              Show exact inventory

            • include=locations

              show the product locations

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • items

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • variantDimensions

            • namestring

            • values

            • isInItemsboolean

            • namestring

            • indexint32

            • filterFields

            • kindstringEnum

              Possible values:

              productPropertycustomFieldvariantproductPrice

            • filterFieldIdint64

            • extFilterFieldIdstring

            • namestring

            • typestringEnum

              Possible values:

              customstringintegerdecimal

            • isAppliedboolean

            • upperBounddecimal


              If field is a number type, marks the upper bound value for items in the result.

            • lowerBounddecimal


              If field is a number type, marks the lower bound value for items in the result.

            • upperGrossBounddecimal


              If field is a number type, marks the upper bound value for items in the un-filtered result.

            • lowerGrossBounddecimal


              If field is a number type, marks the lower bound value for items in the un-filtered result.

            • values

            • nativeValuestring

            • valuestring

            • countint32


              How many items within the result has this value.

            • isAppliedboolean

            • sortOrderint32

            • productMenus

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • extMenuItemIdstring

            • menuItemIdint32

            • descriptionstring

            • alternateDescriptionstring

            • uiSortOrderint32

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • articles

            • scoresingle

            • navigateUrlstring

            • navigateTextstring

            • navigateTargetstring

            • uiSortOrderint32

            • descriptionstring

            • metaData


              Meta data and settings for rendering this list.

            • showProductIdboolean

            • showProductEanboolean

            • showProductManufacturerSkuboolean

            • showExtProductIdboolean

            • showAltExtProductIdboolean

            • enableAddToBasketboolean

            • unitOfMeasures

            • unitOfMeasureIdint32

            • extUnitOfMeasureIdstring

            • abbreviationstring


              Short notation of the unit. Try using abbreviations familiar to your clients.

            • siUnitstringEnum


              Indicates if the unit is a standardized unit (f.inst kilo) or non-standardized unit (f.inst box or pallet)

              Lists the 7 fundamental unit of measures based on the International System of Units (SI). See https://en.wikipedia.org/wiki/SI_base_unit .
              An additional 8th unit ia added to describe abstract business specific units, like "each" or "box", that does not translate very well to an SI unit.
              This enumeration is used to describe physical and/or logistical aspects of an .

              Possible values:

              nonSiUnitlengthmasstimeelectricCurrentthermoDynamicTemperatureamountOfSubstanceluminousIntensity

            • conversionFactordecimal


              Indicates how this unit mathematical relates to its base unit.
              Base units will have conversion factor 1.

            • baseUnitOfMeasureIdint32


              If this unit relates to another unit. All units with the same base can be converted between each other.

            • descriptionstring


              A more elaborate description of this unit. Try using terms familiar to your clients.

            • items

            • itemVersionstring

            • extVariantIdstring

            • extItemIdstring

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • namestring

            • shortDescriptionstring

            • longDescriptionstring

            • seoMetaTagKeywordsstring

            • seoHtmlTitlestring

            • seoMetaTagDescriptionstring

            • scoredouble

            • variantNamestring

            • variantValuesstring

            • hasVariantsboolean

            • hasSalesPriceboolean

            • showSalesPriceboolean

            • frontPageProductboolean

            • greatBuyboolean

            • noveltyProductboolean

            • deprecatedboolean

            • manufacturerIdint32

            • manufacturerstring

            • manufacturerSkustring

            • hasExpectedDeliveryDateboolean

            • expectedDeliveryDatedateTime

            • shipmentsstring

            • isBuyableboolean

            • isConfiguredProductboolean

            • showAddToBasketboolean

            • showAddToFavoritesboolean

            • boundToInventoryCountboolean

            • stocklevelint32

            • locations

            • locationIdint64

            • extLocationIdstring

            • isBuyableboolean

            • isVisibleInShopboolean

            • stocklevelint32

            • boundToInventoryCountboolean

            • stockAvailabilitystring

            • grossWeight


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnit

            • unitOfMeasureIdint32

            • abbreviationstring

            • salesUnitConstraints

            • extSalesUnitConstraintIdstring

            • smallestCountdecimal


              Indicates least common multiple in which that this item can be bought. Quantity bought must be a multiple of this value.
              F.inst if your unit is kilo, 1 indicates you buy in chunks of kilos, 0.5 indicates you buy in chunks of half-kilos (note: scale would then be 1 to allow for a decimal)

            • minimumCountdecimal


              Indicates the minimum number of units clients are required to buy.

            • maximumCountdecimal

            • scaleint32


              Indicates how many decimal places should be shown and accepted for the related unit. this would typically be 1 (one) if buying in chunks of whole units.

            • stockAvailabilitystring

            • salesPrices

            • amount


              Shows an amount in a specific unit with reference to the unit specification.

            • amountdecimal

            • unitOfMeasureIdint32

            • abbreviationstring

            • beforePrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • recommendedPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • salesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • totalSalesPrice


              A special implementation of IPrice, that targets api usage.

            • currencySymbolstring

            • vatPercentagedecimal

            • vatAmountdecimal

            • isPriceIncVatboolean

            • priceIncVatdecimal

            • priceExVatdecimal

            • tagPricedecimal

            • descriptionstring

            • discountLabelstring

            • salesPriceLabelstring

            • validFromdateTime


              Date and time in UTC, from when this price takes effect.

            • validTodateTime


              Date and time in UTC when this price is no longer valid.

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • customFields

            • customFieldIdint64

            • extCustomFieldIdstring

            • valuestring

            • namestring

            • nativeValuestring

            • variants

            • itemKeyitemKey


              Forms a natural key for items within eSeller, combining referencing Item id and the Item kind id into a single structure.
              The kind of item is determined the the typeOfItem portion if this key.

            • itemIdint32

            • typeOfItemstringEnum

              Possible values:

              producttextvariantshipmentpaymentrebateproductconfigurationbomcouponofferofferlinegiftcard

            • suggestedQuantitydecimal

            • eanstring

            • annotationobject

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"id" : "string","apiVersion" : "string","context" : "string","servedBy" : "string","timeServed" : "string","appVersion" : "string","took" : "double","data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","variantDimensions" : [{"name" : "string","values" : [{"isInItems" : "boolean","name" : "string"}],"index" : "int32"}],"filterFields" : [{"kind" : "productProperty | customField | variant | productPrice","filterFieldId" : "int64","extFilterFieldId" : "string","name" : "string","type" : "custom | string | integer | decimal","isApplied" : "boolean","upperBound" : "decimal","lowerBound" : "decimal","upperGrossBound" : "decimal","lowerGrossBound" : "decimal","values" : [{"nativeValue" : "string","value" : "string","count" : "int32","isApplied" : "boolean","sortOrder" : "int32"}]}],"productMenus" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","extMenuItemId" : "string","menuItemId" : "int32","description" : "string","alternateDescription" : "string","uiSortOrder" : "int32","links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}]}],"articles" : [{"score" : "single","navigateUrl" : "string","navigateText" : "string","navigateTarget" : "string","uiSortOrder" : "int32","description" : "string"}],"metaData" : {"showProductId" : "boolean","showProductEan" : "boolean","showProductManufacturerSku" : "boolean","showExtProductId" : "boolean","showAltExtProductId" : "boolean","enableAddToBasket" : "boolean"},"unitOfMeasures" : [{"unitOfMeasureId" : "int32","extUnitOfMeasureId" : "string","abbreviation" : "string","siUnit" : "nonSiUnit | length | mass | time | electricCurrent | thermoDynamicTemperature | amountOfSubstance | luminousIntensity","conversionFactor" : "decimal","baseUnitOfMeasureId" : "int32","description" : "string"}],"items" : [{"itemVersion" : "string","extVariantId" : "string","extItemId" : "string","itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"},"name" : "string","shortDescription" : "string","longDescription" : "string","seoMetaTagKeywords" : "string","seoHtmlTitle" : "string","seoMetaTagDescription" : "string","score" : "double","variantName" : "string","variantValues" : "string","hasVariants" : "boolean","hasSalesPrice" : "boolean","showSalesPrice" : "boolean","frontPageProduct" : "boolean","greatBuy" : "boolean","noveltyProduct" : "boolean","deprecated" : "boolean","manufacturerId" : "int32","manufacturer" : "string","manufacturerSku" : "string","hasExpectedDeliveryDate" : "boolean","expectedDeliveryDate" : "dateTime","shipments" : "string","isBuyable" : "boolean","isConfiguredProduct" : "boolean","showAddToBasket" : "boolean","showAddToFavorites" : "boolean","boundToInventoryCount" : "boolean","stocklevel" : "int32","locations" : [{"locationId" : "int64","extLocationId" : "string","isBuyable" : "boolean","isVisibleInShop" : "boolean","stocklevel" : "int32","boundToInventoryCount" : "boolean","stockAvailability" : "string"}],"grossWeight" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"salesUnit" : [{"unitOfMeasureId" : "int32","abbreviation" : "string"}],"salesUnitConstraints" : [{"extSalesUnitConstraintId" : "string","smallestCount" : "decimal","minimumCount" : "decimal","maximumCount" : "decimal","scale" : "int32"}],"stockAvailability" : "string","salesPrices" : [{"amount" : {"amount" : "decimal","unitOfMeasureId" : "int32","abbreviation" : "string"},"beforePrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"recommendedPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"salesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"totalSalesPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"description" : "string","discountLabel" : "string","salesPriceLabel" : "string","validFrom" : "dateTime","validTo" : "dateTime"}],"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customFields" : [{"customFieldId" : "int64","extCustomFieldId" : "string","value" : "string","name" : "string","nativeValue" : "string"}],"variants" : [{"itemKey" : {"itemId" : "int32","typeOfItem" : "product | text | variant | shipment | payment | rebate | productconfiguration | bom | coupon | offer | offerline | giftcard"}}],"suggestedQuantity" : "decimal","ean" : "string","annotation" : "object"}]}}]}}

            SalesPersons

            GET/services/v3/salespersons/current

            Get the salesperson and login information that corresponds to the supplied authentication.

            Authentication header is required with one of the following roles: SalesPerson, SalesPersonWithCustomerInContext

            Returns state headers.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • salesperson

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • salespersonIdint32


              Salesperson ID

            • extSalespersonIdstring


              Ext. SalespersonID

            • namestring

            • titlestring

            • emailstring

            • phoneNumber1string

            • phoneNumber2string

            • faxstring

            • policiessalesPersonPoliciesEnum

              Possible values:

              EnabledShopFrontAccess

            • login

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • salesPersonLoginIdint32

            • userNamestring

            • emailstring

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"salesperson" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salespersonId" : "int32","extSalespersonId" : "string","name" : "string","title" : "string","email" : "string","phoneNumber1" : "string","phoneNumber2" : "string","fax" : "string","policies" : "Enabled | ShopFrontAccess"},"login" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"salesPersonLoginId" : "int32","userName" : "string","email" : "string"}}}

            Response codes

            Http response Description
            Returns the login and salesperson information for the current authentication.

            SalesPersons

            GET/services/v3/salespersons/current/customers

            Get available customers for current salesperson.

            Authentication header is required with one of the following roles: SalesPerson, SalesPersonWithCustomerInContext

            REQUEST PARAMETERS

            Parameters from Query

            • search

              This parameter turns the request into a search, where items are qualified by the search text.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • items

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • customerIdint32


              Customer ID.

            • extCustomerIdstring


              Ext. customer ID.

            • policiescustomerPoliciesEnum


              The policies of the customer - that is information about what actions are possible for the customer.

              Possible values:

              CanBuyCanUpdateSellToAddressDeletableEnabledShopFrontAccess

            • currency


              The currency that should be considered preferred by customer if any.

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • currencyIdint32

            • extCurrencyIdstring

            • displayNamestring

            • uISortOrderint32

            • namestring

            • iso4217Alpha3string

            • iso4217Numericint32

            • decimalSeparatorstring

            • decimalDigitsint32

            • decimalGroupSeparatorstring

            • groupSizeint32

            • positivePatternint32

            • negativePatternint32

            • billToAddress

            • isEnabledboolean

            • isConfirmedboolean

            • constraints

            • fieldNamestring

            • kindkindOfField

            • fieldPolicystring

            • lookupstring

            • regExValidationstring

            • maxLengthint32

            • lowerBounddecimal

            • upperBounddecimal

            • companyNamestring

            • attentionstring

            • namestring

            • addressstring

            • address2string

            • zipCodestring

            • citystring

            • country

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • countryIdint32

            • extCountryIdstring

            • namestring

            • isDefaultCountryboolean

            • sortOrderint32

            • iso3166Alpha3string

            • iso3166Alpha2string

            • emailstring

            • referencestring

            • phoneNumberstring

            • mobilePhoneNumberstring

            • faxNumberstring

            • vATNumberstring

            • eInvoiceCustomerReferencestring

            • eInvoiceCustomerExtDocNostring

            • eInvoiceCustomerReceiverCodestring

            • eInvoiceCustomerIntPostingNostring

            • sellToAddress

            • isEnabledboolean

            • isConfirmedboolean

            • constraints

            • fieldNamestring

            • kindkindOfField

            • fieldPolicystring

            • lookupstring

            • regExValidationstring

            • maxLengthint32

            • lowerBounddecimal

            • upperBounddecimal

            • companyNamestring

            • attentionstring

            • namestring

            • addressstring

            • address2string

            • zipCodestring

            • citystring

            • country

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • countryIdint32

            • extCountryIdstring

            • namestring

            • isDefaultCountryboolean

            • sortOrderint32

            • iso3166Alpha3string

            • iso3166Alpha2string

            • emailstring

            • referencestring

            • phoneNumberstring

            • mobilePhoneNumberstring

            • faxNumberstring

            • vATNumberstring

            • eInvoiceCustomerReferencestring

            • eInvoiceCustomerExtDocNostring

            • eInvoiceCustomerReceiverCodestring

            • eInvoiceCustomerIntPostingNostring

            • shipToAddresses

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • customerShipToAddressIdint32

            • customerIDint32

            • customerShipToAddressGuidguid

            • extCustomerShipToAddressIdstring

            • companyNamestring

            • namestring

            • attentionstring

            • addressstring

            • address2string

            • zipcodestring

            • citystring

            • countryIdint32

            • isDefaultShipToAddressboolean

            • dateCreateddateTime

            • dateModifieddateTime

            • constraints

            • fieldNamestring

            • kindkindOfField

            • fieldPolicystring

            • lookupstring

            • regExValidationstring

            • maxLengthint32

            • lowerBounddecimal

            • upperBounddecimal

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerId" : "int32","extCustomerId" : "string","policies" : "CanBuy | CanUpdateSellToAddress | Deletable | Enabled | ShopFrontAccess","currency" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"currencyId" : "int32","extCurrencyId" : "string","displayName" : "string","uISortOrder" : "int32","name" : "string","iso4217Alpha3" : "string","iso4217Numeric" : "int32","decimalSeparator" : "string","decimalDigits" : "int32","decimalGroupSeparator" : "string","groupSize" : "int32","positivePattern" : "int32","negativePattern" : "int32"},"billToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"sellToAddress" : {"isEnabled" : "boolean","isConfirmed" : "boolean","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}],"companyName" : "string","attention" : "string","name" : "string","address" : "string","address2" : "string","zipCode" : "string","city" : "string","country" : {"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"countryId" : "int32","extCountryId" : "string","name" : "string","isDefaultCountry" : "boolean","sortOrder" : "int32","iso3166Alpha3" : "string","iso3166Alpha2" : "string"},"email" : "string","reference" : "string","phoneNumber" : "string","mobilePhoneNumber" : "string","faxNumber" : "string","vATNumber" : "string","eInvoiceCustomerReference" : "string","eInvoiceCustomerExtDocNo" : "string","eInvoiceCustomerReceiverCode" : "string","eInvoiceCustomerIntPostingNo" : "string"},"shipToAddresses" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"customerShipToAddressId" : "int32","customerID" : "int32","customerShipToAddressGuid" : "guid","extCustomerShipToAddressId" : "string","companyName" : "string","name" : "string","attention" : "string","address" : "string","address2" : "string","zipcode" : "string","city" : "string","countryId" : "int32","isDefaultShipToAddress" : "boolean","dateCreated" : "dateTime","dateModified" : "dateTime","constraints" : [{"fieldName" : "string","kind" : "kindOfField","fieldPolicy" : "string","lookup" : "string","regExValidation" : "string","maxLength" : "int32","lowerBound" : "decimal","upperBound" : "decimal"}]}]}]}}

            Response codes

            Http response Description
            Returns the customer information for the current authenticated sales person.

            Languages

            GET/services/v3/languages

            Return a list of languages which are enabled and against viewshop parameters

            Authentication header is not allowed.

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • messages

            • severitystringEnum


              The severity of the message.

              Possible values:

              debuginfowarningerrorfatalsecurity

            • messagestring


              Localized message.

            • resultCodestringEnum


              The result code helps you identify what kind of issue the message is about.

              Possible values:

              okwarningnotFoundconstraintFailureunAuthorizedother

            • errorCodestring


              An invariant text string containing identification of the error,
              i.e. a never-changing non-localized text code usable for programmatic handling of the message.

            • kindstring


              Literal reference to what item this message relates to.
              Together with the reference property, this enables you to locate exactly what item was
              the source for this message.

            • referencestring


              Together with kind, this identifies exactly what item caused the message.

            • kindstring

            • currentItemCountint32

            • totalItemsint32

            • grossItemsint32

            • itemsPerPageint32

            • startIndexint32

            • pagingLinkTemplatestring

            • pageIndexint32

            • totalPagesint32

            • nextLinkstring

            • previousLinkstring

            • attributesobject

            • items

            • links

            • rellinkRel


              Specifies what relation this link has to the resource it is declared upon.

            • hrefstring


              Specifies the link to the resource. This would be a relative link.

            • actionlinkAction


              Represents the action suggested to use the resource.

            • titlestring


              The title of the resource, that describes the link.

            • nestedLevelint32


              If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

            • sizeTypeIdint32


              For image resources, this represents the image type of the request.

            • targetContentlinkTargetContent


              An abstract content type describing what kind of data to expect from the resource.

            • targetMediaTypestring


              Describes what media type to expect from the resource in a technical described as mime.

            • languageIdint32

            • nativeNamestring

            • extLanguageIdstring

            • iso639AlphaCode3string

            • iso639AlphaCode2string

            • uiSortOrderint32

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"languageId" : "int32","nativeName" : "string","extLanguageId" : "string","iso639AlphaCode3" : "string","iso639AlphaCode2" : "string","uiSortOrder" : "int32"}]}}

            DocumentModel

            GET/services/v3/docmodel/{documentType}/{documentKey}

            Returns a document.

            Authentication header is not allowed.

            Returns state headers.

            REQUEST PARAMETERS

            Parameters from Uri

            • documentTypestringREQUIRED

            • documentKeystringREQUIRED

            RESPONSE

            Response fields

            • idstring


              Represents a unique ID for the task carried out by a request.
              The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
              The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
              Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
              The Id is required in Api response.

            • apiVersionstring


              This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

            • contextstring


              Echoes the context from the original request.
              This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

            • servedBystring


              This states a name of the actual server serving the response.
              This has no practical use other but supplying an ensurance of the platform in service.

            • timeServedstring


              Returns the time in UTC when the request was created.

            • appVersionstring


              Returns the application build version.

            • tookdouble


              Returns the complete time it took to process the request.

            • data

            • documentTypestring

            • streambyte

            Response body

            {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"documentType" : "string","stream" : "byte"}}

            BasketLine

            GET/sessionservices/v2/basket/current/line

            Gets lines from current basket.

            Authentication header is not allowed.

            REQUEST PARAMETERS

            Parameters from Query

            • include

              Specifies if the response will include additional content: "include=desc" means that response will contain line descriptions and images

            • imgSizeId

              Allows to specify image size ID. It will determine image urls that will be used in response

              Request body

              {
"value" : ""}

              RESPONSE

              Response fields

              • idstring


                Represents a unique ID for the task carried out by a request.
                The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
                The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
                Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
                The Id is required in Api response.

              • apiVersionstring


                This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

              • contextstring


                Echoes the context from the original request.
                This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

              • servedBystring


                This states a name of the actual server serving the response.
                This has no practical use other but supplying an ensurance of the platform in service.

              • timeServedstring


                Returns the time in UTC when the request was created.

              • appVersionstring


                Returns the application build version.

              • tookdouble


                Returns the complete time it took to process the request.

              • data


                Basket

              • idint32


                Gets or sets the id of the basket line.

              • tagstring

              • parentIdint32


                Gets or sets the id of the parent basket line.

              • itemContentstringEnum

                Possible values:

                producttextauctionProductproductVariantlogicaProductAssortmentlogicaProductAssortmentVariantshipmentpaymentrebatelogicaProductAssortmentProductVariantconfiguredProductbomProductcoupondealdealLinegiftCard

              • itemSubTypestringEnum

                Possible values:

                standarddiscountdeposit

              • isLineEditableboolean

              • isLineDeleteableboolean

              • isLineCollapseboolean


                Gets a value indicating if any child lines should be initially collapsed.

              • isAmountVisibleboolean

              • isQuantityVisibleboolean

              • isAmountInTotalsboolean

              • internalItemId1int32


                Gets or sets the ID of this instance. This is the identity column of the underlying database table.

              • internalItemId2int32

              • externalItemId1string


                Gets or sets the external ID of this item. This is usually the id recognized by external community and systems.

              • externalItemId2string

              • secondaryIdstring

              • eANstring

              • posIDstring

              • quantitydecimal

              • lineAmount


                A special implementation of IPrice, that targets api usage.

              • currencySymbolstring

              • vatPercentagedecimal

              • vatAmountdecimal

              • isPriceIncVatboolean

              • priceIncVatdecimal

              • priceExVatdecimal

              • tagPricedecimal

              • unitPrice


                A special implementation of IPrice, that targets api usage.

              • currencySymbolstring

              • vatPercentagedecimal

              • vatAmountdecimal

              • isPriceIncVatboolean

              • priceIncVatdecimal

              • priceExVatdecimal

              • tagPricedecimal

              • itemUrlstring

              • itemImageUrlstring

              • description1string

              • description2string

              • description3string

              • deliveryDatedateTime

              • priceCalculationDatedateTime

              • userCode1string

              • userCode2string

              • userCode3string

              Response body

              {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"id" : "int32","tag" : "string","parentId" : "int32","itemContent" : "product | text | auctionProduct | productVariant | logicaProductAssortment | logicaProductAssortmentVariant | shipment | payment | rebate | logicaProductAssortmentProductVariant | configuredProduct | bomProduct | coupon | deal | dealLine | giftCard","itemSubType" : "standard | discount | deposit","isLineEditable" : "boolean","isLineDeleteable" : "boolean","isLineCollapse" : "boolean","isAmountVisible" : "boolean","isQuantityVisible" : "boolean","isAmountInTotals" : "boolean","internalItemId1" : "int32","internalItemId2" : "int32","externalItemId1" : "string","externalItemId2" : "string","secondaryId" : "string","eAN" : "string","posID" : "string","quantity" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"itemUrl" : "string","itemImageUrl" : "string","description1" : "string","description2" : "string","description3" : "string","deliveryDate" : "dateTime","priceCalculationDate" : "dateTime","userCode1" : "string","userCode2" : "string","userCode3" : "string"}}

              Response codes

              Http response Description
              200 OK Everything is fine
              400 BadRequest The request was not understood
              404 NotFound There is no basket context

              BasketLine

              POST/sessionservices/v2/basket/current/line

              Adds lines to basket and returns all newly created lines from current basket. Accepts an array of BasketLineBody's to allow for modifying multiple lines at once.

              Authentication header is not allowed.

              REQUEST PARAMETERS

              Parameters from Query

              • include

                Specifies if the response will include additional content: "include=desc" means that response will contain line descriptions and images

              • imgSizeId

                Allows to specify image size ID. It will determine image urls that will be used in response

                Parameters from Body

                • referencingIdint32


                  Gets or sets the id of product/variant/offer. Required when POST'ing.

                • productTypestringEnum


                  Type of basket line product. Required when POST'ing.
                  Note: Certain values will be rejected, f.inst offerLine...

                  This enum defines kind of basket line item

                  Possible values:

                  productvariantoffertext

                • createOptionstringEnum


                  Line creation option. By default eSeller tries to add to an existing identical item in basket.
                  Possible values are:
                  Default,
                  CreateNewLine

                  Enum controlling how to alter default basket line creation behaviour (update or new)

                  Possible values:

                  defaultcreateNewLine

                • basketLineIdint32


                  Gets or sets an id of the current line to be added.
                  This id is ONLY used as an arbitrary id with a negative value, allowing you to refer to it when adding (new) child items in the same POST request.

                • parentIdint32


                  Gets or sets the id of the parent basket line, either it is an existing line (positive number), or a new line to be added in this request (negative number).

                • quantitydecimal


                  Gets or sets quantity of items.

                • deliveryDatedateTime


                  Gets or sets a date when this particular item should be delivered. This participates in uniqueness of a basket line.

                • priceCalculationDateFollowsDeliveryDateboolean


                  Gets or sets a value indicating what date to use to calculate prices.
                  Note: Requires shop to allow setting price calculation date in API.

                • tagstring


                  Gets or sets a tag to the line. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                  This participates in uniqueness of a basket line.

                • userCode1string


                  String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                  This participates in uniqueness of a basket line.

                • userCode2string


                  String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                  This participates in uniqueness of a basket line.

                • userCode3string


                  String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                  This participates in uniqueness of a basket line.

                • description1string


                  Gets or sets description. Only applicable if item is of type = "text"

                • description2string


                  Gets or sets description. Only applicable if item is of type = "text"

                • description3string


                  Gets or sets a third description. This field is not processed by eSeller, but carried forward to order, free to be use any purpose. This participates in uniqueness of a basket line.

                Request body

                [{
"value" : ""
"referencingId" : "int32","productType" : "product | variant | offer | text","createOption" : "default | createNewLine",
"basketLineId" : "int32",
"parentId" : "int32",
"quantity" : "decimal",
"deliveryDate" : "dateTime",
"priceCalculationDateFollowsDeliveryDate" : "boolean",
"tag" : "string",
"userCode1" : "string",
"userCode2" : "string",
"userCode3" : "string",
"description1" : "string",
"description2" : "string",
"description3" : "string"}]

                RESPONSE

                Response fields

                • idstring


                  Represents a unique ID for the task carried out by a request.
                  The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
                  The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
                  Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
                  The Id is required in Api response.

                • apiVersionstring


                  This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

                • contextstring


                  Echoes the context from the original request.
                  This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

                • servedBystring


                  This states a name of the actual server serving the response.
                  This has no practical use other but supplying an ensurance of the platform in service.

                • timeServedstring


                  Returns the time in UTC when the request was created.

                • appVersionstring


                  Returns the application build version.

                • tookdouble


                  Returns the complete time it took to process the request.

                • data


                  Basket

                • idint32


                  Gets or sets the id of the basket line.

                • tagstring

                • parentIdint32


                  Gets or sets the id of the parent basket line.

                • itemContentstringEnum

                  Possible values:

                  producttextauctionProductproductVariantlogicaProductAssortmentlogicaProductAssortmentVariantshipmentpaymentrebatelogicaProductAssortmentProductVariantconfiguredProductbomProductcoupondealdealLinegiftCard

                • itemSubTypestringEnum

                  Possible values:

                  standarddiscountdeposit

                • isLineEditableboolean

                • isLineDeleteableboolean

                • isLineCollapseboolean


                  Gets a value indicating if any child lines should be initially collapsed.

                • isAmountVisibleboolean

                • isQuantityVisibleboolean

                • isAmountInTotalsboolean

                • internalItemId1int32


                  Gets or sets the ID of this instance. This is the identity column of the underlying database table.

                • internalItemId2int32

                • externalItemId1string


                  Gets or sets the external ID of this item. This is usually the id recognized by external community and systems.

                • externalItemId2string

                • secondaryIdstring

                • eANstring

                • posIDstring

                • quantitydecimal

                • lineAmount


                  A special implementation of IPrice, that targets api usage.

                • currencySymbolstring

                • vatPercentagedecimal

                • vatAmountdecimal

                • isPriceIncVatboolean

                • priceIncVatdecimal

                • priceExVatdecimal

                • tagPricedecimal

                • unitPrice


                  A special implementation of IPrice, that targets api usage.

                • currencySymbolstring

                • vatPercentagedecimal

                • vatAmountdecimal

                • isPriceIncVatboolean

                • priceIncVatdecimal

                • priceExVatdecimal

                • tagPricedecimal

                • itemUrlstring

                • itemImageUrlstring

                • description1string

                • description2string

                • description3string

                • deliveryDatedateTime

                • priceCalculationDatedateTime

                • userCode1string

                • userCode2string

                • userCode3string

                Response body

                {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"id" : "int32","tag" : "string","parentId" : "int32","itemContent" : "product | text | auctionProduct | productVariant | logicaProductAssortment | logicaProductAssortmentVariant | shipment | payment | rebate | logicaProductAssortmentProductVariant | configuredProduct | bomProduct | coupon | deal | dealLine | giftCard","itemSubType" : "standard | discount | deposit","isLineEditable" : "boolean","isLineDeleteable" : "boolean","isLineCollapse" : "boolean","isAmountVisible" : "boolean","isQuantityVisible" : "boolean","isAmountInTotals" : "boolean","internalItemId1" : "int32","internalItemId2" : "int32","externalItemId1" : "string","externalItemId2" : "string","secondaryId" : "string","eAN" : "string","posID" : "string","quantity" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"itemUrl" : "string","itemImageUrl" : "string","description1" : "string","description2" : "string","description3" : "string","deliveryDate" : "dateTime","priceCalculationDate" : "dateTime","userCode1" : "string","userCode2" : "string","userCode3" : "string"}}

                Response codes

                Http response Description
                200 OK Everything is fine
                400 BadRequest The request was not understood
                404 NotFound There is no basket context

                BasketLine

                PUT/sessionservices/v2/basket/current/line

                Updates one or more lines in current basket and returns all updated lines.

                Authentication header is not allowed.

                REQUEST PARAMETERS

                Parameters from Query

                • include

                  Specifies if the response will include additional content: "include=desc" means that response will contain line descriptions and images

                • imgSizeId

                  Allows to specify image size ID. It will determine image urls that will be used in response

                  Parameters from Body

                  • referencingIdint32


                    Gets or sets the id of product/variant/offer. Required when POST'ing.

                  • productTypestringEnum


                    Type of basket line product. Required when POST'ing.
                    Note: Certain values will be rejected, f.inst offerLine...

                    This enum defines kind of basket line item

                    Possible values:

                    productvariantoffertext

                  • createOptionstringEnum


                    Line creation option. By default eSeller tries to add to an existing identical item in basket.
                    Possible values are:
                    Default,
                    CreateNewLine

                    Enum controlling how to alter default basket line creation behaviour (update or new)

                    Possible values:

                    defaultcreateNewLine

                  • basketLineIdint32


                    Gets or sets an id of the current line to be added.
                    This id is ONLY used as an arbitrary id with a negative value, allowing you to refer to it when adding (new) child items in the same POST request.

                  • parentIdint32


                    Gets or sets the id of the parent basket line, either it is an existing line (positive number), or a new line to be added in this request (negative number).

                  • quantitydecimal


                    Gets or sets quantity of items.

                  • deliveryDatedateTime


                    Gets or sets a date when this particular item should be delivered. This participates in uniqueness of a basket line.

                  • priceCalculationDateFollowsDeliveryDateboolean


                    Gets or sets a value indicating what date to use to calculate prices.
                    Note: Requires shop to allow setting price calculation date in API.

                  • tagstring


                    Gets or sets a tag to the line. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                    This participates in uniqueness of a basket line.

                  • userCode1string


                    String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                    This participates in uniqueness of a basket line.

                  • userCode2string


                    String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                    This participates in uniqueness of a basket line.

                  • userCode3string


                    String property for custom usage. This field is not processed by eSeller, but carried forward to order, free to be use any purpose.
                    This participates in uniqueness of a basket line.

                  • description1string


                    Gets or sets description. Only applicable if item is of type = "text"

                  • description2string


                    Gets or sets description. Only applicable if item is of type = "text"

                  • description3string


                    Gets or sets a third description. This field is not processed by eSeller, but carried forward to order, free to be use any purpose. This participates in uniqueness of a basket line.

                  Request body

                  [{
"value" : ""
"referencingId" : "int32","productType" : "product | variant | offer | text","createOption" : "default | createNewLine",
"basketLineId" : "int32",
"parentId" : "int32",
"quantity" : "decimal",
"deliveryDate" : "dateTime",
"priceCalculationDateFollowsDeliveryDate" : "boolean",
"tag" : "string",
"userCode1" : "string",
"userCode2" : "string",
"userCode3" : "string",
"description1" : "string",
"description2" : "string",
"description3" : "string"}]

                  RESPONSE

                  Response fields

                  • idstring


                    Represents a unique ID for the task carried out by a request.
                    The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
                    The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
                    Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
                    The Id is required in Api response.

                  • apiVersionstring


                    This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

                  • contextstring


                    Echoes the context from the original request.
                    This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

                  • servedBystring


                    This states a name of the actual server serving the response.
                    This has no practical use other but supplying an ensurance of the platform in service.

                  • timeServedstring


                    Returns the time in UTC when the request was created.

                  • appVersionstring


                    Returns the application build version.

                  • tookdouble


                    Returns the complete time it took to process the request.

                  • data


                    Basket

                  • idint32


                    Gets or sets the id of the basket line.

                  • tagstring

                  • parentIdint32


                    Gets or sets the id of the parent basket line.

                  • itemContentstringEnum

                    Possible values:

                    producttextauctionProductproductVariantlogicaProductAssortmentlogicaProductAssortmentVariantshipmentpaymentrebatelogicaProductAssortmentProductVariantconfiguredProductbomProductcoupondealdealLinegiftCard

                  • itemSubTypestringEnum

                    Possible values:

                    standarddiscountdeposit

                  • isLineEditableboolean

                  • isLineDeleteableboolean

                  • isLineCollapseboolean


                    Gets a value indicating if any child lines should be initially collapsed.

                  • isAmountVisibleboolean

                  • isQuantityVisibleboolean

                  • isAmountInTotalsboolean

                  • internalItemId1int32


                    Gets or sets the ID of this instance. This is the identity column of the underlying database table.

                  • internalItemId2int32

                  • externalItemId1string


                    Gets or sets the external ID of this item. This is usually the id recognized by external community and systems.

                  • externalItemId2string

                  • secondaryIdstring

                  • eANstring

                  • posIDstring

                  • quantitydecimal

                  • lineAmount


                    A special implementation of IPrice, that targets api usage.

                  • currencySymbolstring

                  • vatPercentagedecimal

                  • vatAmountdecimal

                  • isPriceIncVatboolean

                  • priceIncVatdecimal

                  • priceExVatdecimal

                  • tagPricedecimal

                  • unitPrice


                    A special implementation of IPrice, that targets api usage.

                  • currencySymbolstring

                  • vatPercentagedecimal

                  • vatAmountdecimal

                  • isPriceIncVatboolean

                  • priceIncVatdecimal

                  • priceExVatdecimal

                  • tagPricedecimal

                  • itemUrlstring

                  • itemImageUrlstring

                  • description1string

                  • description2string

                  • description3string

                  • deliveryDatedateTime

                  • priceCalculationDatedateTime

                  • userCode1string

                  • userCode2string

                  • userCode3string

                  Response body

                  {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"id" : "int32","tag" : "string","parentId" : "int32","itemContent" : "product | text | auctionProduct | productVariant | logicaProductAssortment | logicaProductAssortmentVariant | shipment | payment | rebate | logicaProductAssortmentProductVariant | configuredProduct | bomProduct | coupon | deal | dealLine | giftCard","itemSubType" : "standard | discount | deposit","isLineEditable" : "boolean","isLineDeleteable" : "boolean","isLineCollapse" : "boolean","isAmountVisible" : "boolean","isQuantityVisible" : "boolean","isAmountInTotals" : "boolean","internalItemId1" : "int32","internalItemId2" : "int32","externalItemId1" : "string","externalItemId2" : "string","secondaryId" : "string","eAN" : "string","posID" : "string","quantity" : "decimal","lineAmount" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"unitPrice" : {"currencySymbol" : "string","vatPercentage" : "decimal","vatAmount" : "decimal","isPriceIncVat" : "boolean","priceIncVat" : "decimal","priceExVat" : "decimal","tagPrice" : "decimal"},"itemUrl" : "string","itemImageUrl" : "string","description1" : "string","description2" : "string","description3" : "string","deliveryDate" : "dateTime","priceCalculationDate" : "dateTime","userCode1" : "string","userCode2" : "string","userCode3" : "string"}}

                  Response codes

                  Http response Description
                  200 OK Everything is fine
                  400 BadRequest The request was not understood
                  404 NotFound There is no basket context

                  BasketLine

                  DELETE/sessionservices/v2/basket/current/line

                  Deletes all lines from current basket, aka empty basket.

                  Authentication header is not allowed.

                  RESPONSE

                  Response codes

                  Http response Description
                  200 OK Everything is fine
                  400 BadRequest The request was not understood
                  404 NotFound There is no basket context

                  BasketLine

                  DELETE/sessionservices/v2/basket/current/line/{basketLineId}

                  Deletes a line with given ID from current basket.

                  Authentication header is not allowed.

                  REQUEST PARAMETERS

                  Parameters from Uri

                  • basketLineIdint32REQUIRED

                  RESPONSE

                  Response codes

                  Http response Description
                  200 OK Everything is fine
                  400 BadRequest The request was not understood
                  404 NotFound There is no basket context

                  AgeVerification

                  POST/sessionservices/v2/basket/current/ageverification

                  set age verification token id of the current basket

                  Authentication header is not allowed.

                  REQUEST PARAMETERS

                  Parameters from Body

                    Request body

                    {}

                    RESPONSE

                    Response fields

                    • idstring


                      Represents a unique ID for the task carried out by a request.
                      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
                      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
                      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
                      The Id is required in Api response.

                    • apiVersionstring


                      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

                    • contextstring


                      Echoes the context from the original request.
                      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

                    • servedBystring


                      This states a name of the actual server serving the response.
                      This has no practical use other but supplying an ensurance of the platform in service.

                    • timeServedstring


                      Returns the time in UTC when the request was created.

                    • appVersionstring


                      Returns the application build version.

                    • tookdouble


                      Returns the complete time it took to process the request.

                    • data

                    • noncestring

                    • statusstringEnum

                      Possible values:

                      noneprocessingsuccessfailed

                    • tokenIdstring

                    • idBrokerDKAgeVerifiedstring

                    Response body

                    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"nonce" : "string","status" : "none | processing | success | failed","tokenId" : "string","idBrokerDKAgeVerified" : "string"}}

                    Response codes

                    Http response Description
                    200 OK Everything is fine
                    400 BadRequest The request was not understood
                    404 NotFound There is no basket context

                    AgeVerification

                    GET/sessionservices/v2/basket/current/ageverification?newNonce={newNonce}

                    Gets age verification of the current basket

                    Authentication header is not allowed.

                    REQUEST PARAMETERS

                    Parameters from Uri

                    • newNonceboolean

                    Parameters from Query

                    • newNonce

                      A value indicating if a new nonce must be generated (true). Default is false, meaning existing nonce will be returned.

                    RESPONSE

                    Response fields

                    • idstring


                      Represents a unique ID for the task carried out by a request.
                      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
                      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
                      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
                      The Id is required in Api response.

                    • apiVersionstring


                      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

                    • contextstring


                      Echoes the context from the original request.
                      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

                    • servedBystring


                      This states a name of the actual server serving the response.
                      This has no practical use other but supplying an ensurance of the platform in service.

                    • timeServedstring


                      Returns the time in UTC when the request was created.

                    • appVersionstring


                      Returns the application build version.

                    • tookdouble


                      Returns the complete time it took to process the request.

                    • data

                    • noncestring

                    • statusstringEnum

                      Possible values:

                      noneprocessingsuccessfailed

                    • tokenIdstring

                    • idBrokerDKAgeVerifiedstring

                    Response body

                    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"nonce" : "string","status" : "none | processing | success | failed","tokenId" : "string","idBrokerDKAgeVerified" : "string"}}

                    Response codes

                    Http response Description
                    200 OK Everything is fine
                    400 BadRequest The request was not understood
                    404 NotFound There is no basket context

                    Locations

                    GET/services/v3/locations

                    List locations.

                    Authentication header is not allowed.

                    REQUEST PARAMETERS

                    Parameters from Query

                    • timescope

                      Limits the resulting list of "collectTimes" in the response. Defines for far into the future collectTimes should be returned. Examples: "6h" (hours), "10d" (days), "30m" (minutes).If omitted, collectTimes are returned for the next 24 hours. CollectTimes can be omitted altogether by setting this parameter to "0d".

                    • interval

                      Defines with what interval to return "collectTimes". Examples: "1h" (hours), "15m" (minutes), "1d" (days).

                    RESPONSE

                    Response fields

                    • idstring


                      Represents a unique ID for the task carried out by a request.
                      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
                      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
                      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
                      The Id is required in Api response.

                    • apiVersionstring


                      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

                    • contextstring


                      Echoes the context from the original request.
                      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

                    • servedBystring


                      This states a name of the actual server serving the response.
                      This has no practical use other but supplying an ensurance of the platform in service.

                    • timeServedstring


                      Returns the time in UTC when the request was created.

                    • appVersionstring


                      Returns the application build version.

                    • tookdouble


                      Returns the complete time it took to process the request.

                    • data

                    • messages

                    • severitystringEnum


                      The severity of the message.

                      Possible values:

                      debuginfowarningerrorfatalsecurity

                    • messagestring


                      Localized message.

                    • resultCodestringEnum


                      The result code helps you identify what kind of issue the message is about.

                      Possible values:

                      okwarningnotFoundconstraintFailureunAuthorizedother

                    • errorCodestring


                      An invariant text string containing identification of the error,
                      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

                    • kindstring


                      Literal reference to what item this message relates to.
                      Together with the reference property, this enables you to locate exactly what item was
                      the source for this message.

                    • referencestring


                      Together with kind, this identifies exactly what item caused the message.

                    • kindstring

                    • currentItemCountint32

                    • totalItemsint32

                    • grossItemsint32

                    • itemsPerPageint32

                    • startIndexint32

                    • pagingLinkTemplatestring

                    • pageIndexint32

                    • totalPagesint32

                    • nextLinkstring

                    • previousLinkstring

                    • attributesobject

                    • items

                    • links

                    • rellinkRel


                      Specifies what relation this link has to the resource it is declared upon.

                    • hrefstring


                      Specifies the link to the resource. This would be a relative link.

                    • actionlinkAction


                      Represents the action suggested to use the resource.

                    • titlestring


                      The title of the resource, that describes the link.

                    • nestedLevelint32


                      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

                    • sizeTypeIdint32


                      For image resources, this represents the image type of the request.

                    • targetContentlinkTargetContent


                      An abstract content type describing what kind of data to expect from the resource.

                    • targetMediaTypestring


                      Describes what media type to expect from the resource in a technical described as mime.

                    • locationIdint64


                      The ID of the location.
                      May be used to fetch a specific location.

                    • extLocationIdstring


                      Location ext. ID.

                    • posIdstring


                      Only relevant to locations integrated with an external POS system.

                    • isDefaultboolean


                      Defines whether the location is default for the current shop.

                    • isBuyableboolean


                      Defines whether items may be ordered from this location.

                    • showAddToBasketboolean


                      Defines wheter "add to basket" buttons should be visible for this location.

                    • uiSortorderint32


                      Sort order value that may be used to order a list of locations according to this value.

                    • locationNamestring


                      The name of the location.

                    • isVisibleInShopboolean


                      Defines whether the location should be shown in the shop.
                      This flag does no no influence wether this location can be used to sell from.

                    • namestring


                      Location address name.

                    • name2string


                      Location address name2.

                    • addressstring


                      Location Address.

                    • address2string


                      Location Address2.

                    • citystring


                      Location address city.

                    • postCodestring


                      Location address post code.

                    • countystring


                      Location address county.

                    • countryIdint32


                      Location address country.

                    • emailAddressstring


                      Location e-mail address. May receive a copy of order confirmation e-mails.

                    • contactstring


                      Location contact.

                    • phoneNumberstring


                      Location phone number.

                    • faxNumberstring


                      Location fax number.

                    • leadTimetimespan


                      Location lead time.
                      An off-set in hours from the order is placed to when it may be collected at a physical location.

                    • openingHours


                      Returns any opening hours defined for the location.

                    • validityDatedateTime


                      The date of the "special" opening hour.
                      Only returned for "special" opening hours.

                    • openFromtimespan


                      Time of day from when the physical location is open.

                    • openTotimespan


                      Time of day to when the physical location is open.

                    • isClosedboolean


                      Flag indicating whether the physical location is open.

                    • commentstring


                      Optional comment to show for the opening hour (not localized).

                    • isOpenForCollectionboolean


                      Flag indicating whether the physical location is open for collect orders.

                    • collectOpenFromtimespan


                      Time of day from when the physical location is open for collect orders.

                    • collectOpenTotimespan


                      Time of day to when the physical location is open for collect orders.

                    • dayOfTheWeekint32


                      Numeric representation of the week day.
                      0 = Sunday.

                    • specialOpeningHours


                      Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

                    • validityDatedateTime


                      The date of the "special" opening hour.
                      Only returned for "special" opening hours.

                    • openFromtimespan


                      Time of day from when the physical location is open.

                    • openTotimespan


                      Time of day to when the physical location is open.

                    • isClosedboolean


                      Flag indicating whether the physical location is open.

                    • commentstring


                      Optional comment to show for the opening hour (not localized).

                    • isOpenForCollectionboolean


                      Flag indicating whether the physical location is open for collect orders.

                    • collectOpenFromtimespan


                      Time of day from when the physical location is open for collect orders.

                    • collectOpenTotimespan


                      Time of day to when the physical location is open for collect orders.

                    • dayOfTheWeekint32


                      Numeric representation of the week day.
                      0 = Sunday.

                    • collectTimesdateTime


                      Returns any collect times for the context of the request.
                      Setting the "timescope" and "interval" query parameters in the request influences what is returned.

                    Response body

                    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"}]}}

                    Response codes

                    Http response Description
                    Returns a list of locations available.

                    Locations

                    GET/services/v3/locations/{locationId}

                    List a specific location.

                    Authentication header is not allowed.

                    REQUEST PARAMETERS

                    Parameters from Uri

                    • locationIdint32REQUIRED

                    Parameters from Query

                    • timescope

                      Limits the resulting list of "collectTimes" in the response. Defines for far into the future collectTimes should be returned. Examples: "6h" (hours), "10d" (days), "30m" (minutes).If omitted, collectTimes are returned for the next 24 hours. CollectTimes can be omitted altogether by setting this parameter to "0d".

                    • interval

                      Defines with what interval to return "collectTimes". Examples: "1h" (hours), "15m" (minutes), "1d" (days).

                    RESPONSE

                    Response fields

                    • idstring


                      Represents a unique ID for the task carried out by a request.
                      The Id serves as an identifier for querying status of a task. This gives frontend developers a tool to request an async, long running task, allowing to query the progress / status of this task.
                      The Id also serves a handle for support in case the request needs inevestigation, f.inst. if a failure occurs.
                      Id is an abitrary string of max 50 characters. It implies no meaning of its own, and has no predictable format or sequence.
                      The Id is required in Api response.

                    • apiVersionstring


                      This is the version of the API that served the request. The Api version only changes if major changes are implemented into the Api that could break operation.

                    • contextstring


                      Echoes the context from the original request.
                      This should be a client supplied identifier, enabling frontend developers to pair response with original request, thereby encouraging async programming models.

                    • servedBystring


                      This states a name of the actual server serving the response.
                      This has no practical use other but supplying an ensurance of the platform in service.

                    • timeServedstring


                      Returns the time in UTC when the request was created.

                    • appVersionstring


                      Returns the application build version.

                    • tookdouble


                      Returns the complete time it took to process the request.

                    • data

                    • messages

                    • severitystringEnum


                      The severity of the message.

                      Possible values:

                      debuginfowarningerrorfatalsecurity

                    • messagestring


                      Localized message.

                    • resultCodestringEnum


                      The result code helps you identify what kind of issue the message is about.

                      Possible values:

                      okwarningnotFoundconstraintFailureunAuthorizedother

                    • errorCodestring


                      An invariant text string containing identification of the error,
                      i.e. a never-changing non-localized text code usable for programmatic handling of the message.

                    • kindstring


                      Literal reference to what item this message relates to.
                      Together with the reference property, this enables you to locate exactly what item was
                      the source for this message.

                    • referencestring


                      Together with kind, this identifies exactly what item caused the message.

                    • kindstring

                    • currentItemCountint32

                    • totalItemsint32

                    • grossItemsint32

                    • itemsPerPageint32

                    • startIndexint32

                    • pagingLinkTemplatestring

                    • pageIndexint32

                    • totalPagesint32

                    • nextLinkstring

                    • previousLinkstring

                    • attributesobject

                    • items

                    • links

                    • rellinkRel


                      Specifies what relation this link has to the resource it is declared upon.

                    • hrefstring


                      Specifies the link to the resource. This would be a relative link.

                    • actionlinkAction


                      Represents the action suggested to use the resource.

                    • titlestring


                      The title of the resource, that describes the link.

                    • nestedLevelint32


                      If the resource has a logical distance from the actual data, f.inst a nested level or inheritance.

                    • sizeTypeIdint32


                      For image resources, this represents the image type of the request.

                    • targetContentlinkTargetContent


                      An abstract content type describing what kind of data to expect from the resource.

                    • targetMediaTypestring


                      Describes what media type to expect from the resource in a technical described as mime.

                    • locationIdint64


                      The ID of the location.
                      May be used to fetch a specific location.

                    • extLocationIdstring


                      Location ext. ID.

                    • posIdstring


                      Only relevant to locations integrated with an external POS system.

                    • isDefaultboolean


                      Defines whether the location is default for the current shop.

                    • isBuyableboolean


                      Defines whether items may be ordered from this location.

                    • showAddToBasketboolean


                      Defines wheter "add to basket" buttons should be visible for this location.

                    • uiSortorderint32


                      Sort order value that may be used to order a list of locations according to this value.

                    • locationNamestring


                      The name of the location.

                    • isVisibleInShopboolean


                      Defines whether the location should be shown in the shop.
                      This flag does no no influence wether this location can be used to sell from.

                    • namestring


                      Location address name.

                    • name2string


                      Location address name2.

                    • addressstring


                      Location Address.

                    • address2string


                      Location Address2.

                    • citystring


                      Location address city.

                    • postCodestring


                      Location address post code.

                    • countystring


                      Location address county.

                    • countryIdint32


                      Location address country.

                    • emailAddressstring


                      Location e-mail address. May receive a copy of order confirmation e-mails.

                    • contactstring


                      Location contact.

                    • phoneNumberstring


                      Location phone number.

                    • faxNumberstring


                      Location fax number.

                    • leadTimetimespan


                      Location lead time.
                      An off-set in hours from the order is placed to when it may be collected at a physical location.

                    • openingHours


                      Returns any opening hours defined for the location.

                    • validityDatedateTime


                      The date of the "special" opening hour.
                      Only returned for "special" opening hours.

                    • openFromtimespan


                      Time of day from when the physical location is open.

                    • openTotimespan


                      Time of day to when the physical location is open.

                    • isClosedboolean


                      Flag indicating whether the physical location is open.

                    • commentstring


                      Optional comment to show for the opening hour (not localized).

                    • isOpenForCollectionboolean


                      Flag indicating whether the physical location is open for collect orders.

                    • collectOpenFromtimespan


                      Time of day from when the physical location is open for collect orders.

                    • collectOpenTotimespan


                      Time of day to when the physical location is open for collect orders.

                    • dayOfTheWeekint32


                      Numeric representation of the week day.
                      0 = Sunday.

                    • specialOpeningHours


                      Returns any "special" opening hours defined for the location - that is, exceptions to the "normal" opening hours.

                    • validityDatedateTime


                      The date of the "special" opening hour.
                      Only returned for "special" opening hours.

                    • openFromtimespan


                      Time of day from when the physical location is open.

                    • openTotimespan


                      Time of day to when the physical location is open.

                    • isClosedboolean


                      Flag indicating whether the physical location is open.

                    • commentstring


                      Optional comment to show for the opening hour (not localized).

                    • isOpenForCollectionboolean


                      Flag indicating whether the physical location is open for collect orders.

                    • collectOpenFromtimespan


                      Time of day from when the physical location is open for collect orders.

                    • collectOpenTotimespan


                      Time of day to when the physical location is open for collect orders.

                    • dayOfTheWeekint32


                      Numeric representation of the week day.
                      0 = Sunday.

                    • collectTimesdateTime


                      Returns any collect times for the context of the request.
                      Setting the "timescope" and "interval" query parameters in the request influences what is returned.

                    Response body

                    {
"id" : "string",
"apiVersion" : "string",
"context" : "string",
"servedBy" : "string",
"timeServed" : "string",
"appVersion" : "string",
"took" : "double",
"data" : {"messages" : [{"severity" : "debug | info | warning | error | fatal | security","message" : "string","resultCode" : "ok | warning | notFound | constraintFailure | unAuthorized | other","errorCode" : "string","kind" : "string","reference" : "string"}],"kind" : "string","currentItemCount" : "int32","totalItems" : "int32","grossItems" : "int32","itemsPerPage" : "int32","startIndex" : "int32","pagingLinkTemplate" : "string","pageIndex" : "int32","totalPages" : "int32","nextLink" : "string","previousLink" : "string","attributes" : "object","items" : [{"links" : [{"rel" : "linkRel","href" : "string","action" : "linkAction","title" : "string","nestedLevel" : "int32","sizeTypeId" : "int32","targetContent" : "linkTargetContent","targetMediaType" : "string"}],"locationId" : "int64","extLocationId" : "string","posId" : "string","isDefault" : "boolean","isBuyable" : "boolean","showAddToBasket" : "boolean","uiSortorder" : "int32","locationName" : "string","isVisibleInShop" : "boolean","name" : "string","name2" : "string","address" : "string","address2" : "string","city" : "string","postCode" : "string","county" : "string","countryId" : "int32","emailAddress" : "string","contact" : "string","phoneNumber" : "string","faxNumber" : "string","leadTime" : "timespan","openingHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"specialOpeningHours" : [{"validityDate" : "dateTime","openFrom" : "timespan","openTo" : "timespan","isClosed" : "boolean","comment" : "string","isOpenForCollection" : "boolean","collectOpenFrom" : "timespan","collectOpenTo" : "timespan","dayOfTheWeek" : "int32"}],"collectTimes" : "dateTime"}]}}

                    Response codes

                    Http response Description
                    Returns a list of locations available.