OCC API documentation version v2
http://api-example.hybris.com/rest/v2/{baseSiteId}
/cardtypes
get
Lists supported payment card types.
get /cardtypes
Lists supported payment card types.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CardTypeListWsDTO",
"type": "object",
"properties":
{
"cardTypes":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CardTypeWsDTO"
}
}
},
"definitions":
{
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
/catalogs
get
Returns all catalogs with versions defined for the base store.
get /catalogs
Returns all catalogs with versions defined for the base store.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CatalogListWsDTO",
"type": "object",
"properties":
{
"catalogs":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CatalogWsDTO"
}
}
},
"definitions":
{
"CatalogWsDTO":
{
"properties":
{
"catalogVersions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CatalogVersionWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
}
},
"CatalogVersionWsDTO":
{
"properties":
{
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryHierarchyWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
}
},
"CategoryHierarchyWsDTO":
{
"properties":
{
"pageSize":
{
"type": "number"
},
"totalNumber":
{
"type": "number"
},
"currentPage":
{
"type": "number"
},
"numberOfPages":
{
"type": "number"
},
"subcategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryHierarchyWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
}
}
}
}
get
Returns a information about a catalog based on its ID, along with versions defined for the current base store.
get /catalogs/{catalogId}
Returns a information about a catalog based on its ID, along with versions defined for the current base store.
URI Parameters
- catalogId: required (string )
Catalog identifier
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CatalogWsDTO",
"type": "object",
"properties":
{
"catalogVersions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CatalogVersionWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
},
"definitions":
{
"CatalogVersionWsDTO":
{
"properties":
{
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryHierarchyWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
}
},
"CategoryHierarchyWsDTO":
{
"properties":
{
"pageSize":
{
"type": "number"
},
"totalNumber":
{
"type": "number"
},
"currentPage":
{
"type": "number"
},
"numberOfPages":
{
"type": "number"
},
"subcategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryHierarchyWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
}
}
}
}
get
Returns information about catalog version that exists for the current base store.
get /catalogs/{catalogId}/{catalogVersionId}
Returns information about catalog version that exists for the current base store.
URI Parameters
- catalogId: required (string )
Catalog identifier
- catalogVersionId: required (string )
Catalog version identifier
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CatalogVersionWsDTO",
"type": "object",
"properties":
{
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryHierarchyWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
},
"definitions":
{
"CategoryHierarchyWsDTO":
{
"properties":
{
"pageSize":
{
"type": "number"
},
"totalNumber":
{
"type": "number"
},
"currentPage":
{
"type": "number"
},
"numberOfPages":
{
"type": "number"
},
"subcategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryHierarchyWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
}
}
}
}
get
Returns information about category that exists in a catalog version available for the current base store.
get /catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}
Returns information about category that exists in a catalog version available for the current base store.
URI Parameters
- catalogId: required (string )
Catalog identifier
- catalogVersionId: required (string )
Catalog version identifier
- categoryId: required (string )
Category identifier
Query Parameters
- pageSize: (string- default: 20 )
The number of results returned per page.
- currentPage: (string )
The current result page requested.
- fields: (string- default: DEFAULT,totalNumber,pageSize,numberOfPages,currentPage )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CategoryHierarchyWsDTO",
"type": "object",
"properties":
{
"pageSize":
{
"type": "number"
},
"totalNumber":
{
"type": "number"
},
"currentPage":
{
"type": "number"
},
"numberOfPages":
{
"type": "number"
},
"subcategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryHierarchyWsDTO"
}
},
"id":
{
"type": "string"
},
"lastModified":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
}
},
"definitions":
{
}
}
/currencies
get
Lists all available currencies (all usable currencies for the current store).If the list of currencies for stores is empty, a list of all currencies available in the system is returned.
get /currencies
Lists all available currencies (all usable currencies for the current store).If the list of currencies for stores is empty, a list of all currencies available in the system is returned.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CurrencyListWsDTO",
"type": "object",
"properties":
{
"currencies":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CurrencyWsDTO"
}
}
},
"definitions":
{
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
}
}
}
/customergroups
get
Returns all customer groups that are direct subgroups of a customergroup.
Security: Permitted only for customer managers
post
Creates a new customer group that is a direct subgroup of a customergroup.
Security: Permitted only for customer managers
get /customergroups
Returns all customer groups that are direct subgroups of a customergroup.
Security: Permitted only for customer managers
Query Parameters
- pageSize: (string- default: 20 )
Number of customer group returned in one page
- currentPage: (string )
Current page number (starts with 0)
- fields: (string- default: BASIC )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserGroupListWsDTO",
"type": "object",
"properties":
{
"userGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/UserGroupWsDTO"
}
},
"totalNumber":
{
"type": "number"
},
"pageSize":
{
"type": "number"
},
"numberOfPages":
{
"type": "number"
},
"currentPage":
{
"type": "number"
}
},
"definitions":
{
"UserGroupWsDTO":
{
"properties":
{
"members":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PrincipalWsDTO"
}
},
"subGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/UserGroupWsDTO"
}
},
"membersCount":
{
"type": "number"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
post /customergroups
Creates a new customer group that is a direct subgroup of a customergroup.
Security: Permitted only for customer managers
Body
Type: application/x-www-form-urlencoded
Form Parameters- localizedName: (string )
Name in current locale.
- groupId: (string )
Id of new customer group.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserGroupWsDTO",
"type": "object",
"properties":
{
"members":
{
"type": "array",
"items":
{
"type": "object",
"properties":
{
"uid":
{
"type": "string"
}
}
}
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
HTTP status code 201
get
Returns a customer group with a specific groupId.
Security: Permitted only for customer managers
get /customergroups/{groupId}
Returns a customer group with a specific groupId.
Security: Permitted only for customer managers
URI Parameters
- groupId: required (string )
Group identifier
Query Parameters
- fields: (string- default: BASIC )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserGroupWsDTO",
"type": "object",
"properties":
{
"members":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PrincipalWsDTO"
}
},
"subGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/UserGroupWsDTO"
}
},
"membersCount":
{
"type": "number"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
},
"definitions":
{
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
put
Sets members for a user group. The list of existing members is overwritten with a new one.
Security: Permitted only for customer managers
patch
Assigns user(s) to a customer group.
Security: Permitted only for customer managers
put /customergroups/{groupId}/members
Sets members for a user group. The list of existing members is overwritten with a new one.
Security: Permitted only for customer managers
URI Parameters
- groupId: required (string )
Group identifier
Body
Type: application/x-www-form-urlencoded
Form Parameters- members: (string )
List of users id to set for customer group.. List should be in form: members=uid1&members=uid2...
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "MemberListWsDTO",
"type": "object",
"properties":
{
"members":
{
"type": "array",
"items":
{
"type": "object",
"properties":
{
"uid":
{
"type": "string"
}
}
}
}
}
}
HTTP status code 200
patch /customergroups/{groupId}/members
Assigns user(s) to a customer group.
Security: Permitted only for customer managers
URI Parameters
- groupId: required (string )
Group identifier
Body
Type: application/x-www-form-urlencoded
Form Parameters- members: (string )
List of users ids to assign to customer group. List should be in form: members=uid1&members=uid2...
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "MemberListWsDTO",
"type": "object",
"properties":
{
"members":
{
"type": "array",
"items":
{
"type": "object",
"properties":
{
"uid":
{
"type": "string"
}
}
}
}
}
}
HTTP status code 200
delete
Removes user from a customer group.
Security: Permitted only for customer managers
/deliverycountries
get
Lists all supported delivery countries for the current store. The list is sorted alphabetically.
get /deliverycountries
Lists all supported delivery countries for the current store. The list is sorted alphabetically.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CountryListWsDTO",
"type": "object",
"properties":
{
"countries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CountryWsDTO"
}
}
},
"definitions":
{
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
/export
get
Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the given time.
Security: Allowed only for trusted client
get /export/products
Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the given time.
Security: Allowed only for trusted client
Query Parameters
- catalog: (string )
Catalog from which get products. Must be provided along with version.
- pageSize: (string- default: 2147483647 )
The number of results returned per page.
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
- currentPage: (string )
The current result page requested.
- version: (string )
Catalog version. Must be provided along with catalog.
- timestamp: (string )
When this parameter is set, only products modified after given time will be returned.This parameter should be in RFC-8601 format.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ProductListWsDTO",
"type": "object",
"properties":
{
"products":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductWsDTO"
}
},
"catalog":
{
"type": "string"
},
"version":
{
"type": "string"
},
"totalProductCount":
{
"type": "number"
},
"totalPageCount":
{
"type": "number"
},
"currentPage":
{
"type": "number"
}
},
"definitions":
{
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
/feeds
get
Returns the orders the status has changed for. Returns only the elements from the current baseSite, updated after the provided timestamp.
Security: Allowed only for trusted client
get /feeds/orders/statusfeed
Returns the orders the status has changed for. Returns only the elements from the current baseSite, updated after the provided timestamp.
Security: Allowed only for trusted client
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
- timestamp: (string )
Only items newer than the given parameter are retrieved. This parameter should be in RFC-8601 format.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderStatusUpdateElementListWsDTO",
"type": "object",
"properties":
{
"orderStatusUpdateElements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderStatusUpdateElementWsDTO"
}
}
},
"definitions":
{
"OrderStatusUpdateElementWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"status":
{
"type": "string"
},
"baseSiteId":
{
"type": "string"
}
}
}
}
}
/forgottenpasswordtokens
post
Generates a token to restore customer's forgotten password.
Security: Allowed only for client or trusted client
post /forgottenpasswordtokens
/languages
get
Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of all languages available in the system will be returned.
get /languages
Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of all languages available in the system will be returned.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "LanguageListWsDTO",
"type": "object",
"properties":
{
"languages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/LanguageWsDTO"
}
}
},
"definitions":
{
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
}
}
}
/orders
get
Returns details of a specific order based on order GUID (Globally Unique Identifier) or order CODE. The response contains a detailed order information.
Security: Allowed only for trusted client
get /orders/{code}
Returns details of a specific order based on order GUID (Globally Unique Identifier) or order CODE. The response contains a detailed order information.
Security: Allowed only for trusted client
URI Parameters
- code: required (string )
Order GUID (Globally Unique Identifier) or order CODE
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderWsDTO",
"type": "object",
"properties":
{
"created":
{
"type": "string"
},
"status":
{
"type": "string"
},
"statusDisplay":
{
"type": "string"
},
"guestCustomer":
{
"type": "boolean"
},
"consignments":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ConsignmentWsDTO"
}
},
"deliveryStatus":
{
"type": "string"
},
"deliveryStatusDisplay":
{
"type": "string"
},
"unconsignedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
},
"definitions":
{
"ConsignmentWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"trackingID":
{
"type": "string"
},
"status":
{
"type": "string"
},
"statusDate":
{
"type": "string"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ConsignmentEntryWsDTO"
}
},
"shippingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"ConsignmentEntryWsDTO":
{
"properties":
{
"orderEntry":
{
"$ref": "#/definitions/OrderEntryWsDTO"
},
"quantity":
{
"type": "number"
},
"shippedQuantity":
{
"type": "number"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
}
}
}
/products
get
Returns products added to the express update feed. Returns only elements updated after the provided timestamp.The queue is cleared using a defined cronjob.
Security: Permitted only for trusted client
get /products/expressupdate
Returns products added to the express update feed. Returns only elements updated after the provided timestamp.The queue is cleared using a defined cronjob.
Security: Permitted only for trusted client
Query Parameters
- catalog: (string )
Only products from this catalog are returned. Format: catalogId:catalogVersion
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
- timestamp: (string )
Only items newer than the given parameter are retrieved from the queue. This parameter should be in RFC-8601 format.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ProductExpressUpdateElementListWsDTO",
"type": "object",
"properties":
{
"productExpressUpdateElements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductExpressUpdateElementWsDTO"
}
}
},
"definitions":
{
"ProductExpressUpdateElementWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"catalogId":
{
"type": "string"
},
"catalogVersion":
{
"type": "string"
}
}
}
}
}
head
Returns X-Total-Count header with total number of products satisfying a query. It doesn't return HTTP body.
get
Returns a list of products and additional data such as: available facets, available sorting and pagination options. It can include spelling suggestions.To make spelling suggestions work you need to:
- Make sure enableSpellCheck on the SearchQuery is set to true. By default it should be already set to true.
- Have indexed properties configured to be used for spellchecking.
head /products/search
Returns X-Total-Count header with total number of products satisfying a query. It doesn't return HTTP body.
Query Parameters
- query: (string )
Serialized query, free text search, facets.
The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2
HTTP status code 200
get /products/search
Returns a list of products and additional data such as: available facets, available sorting and pagination options. It can include spelling suggestions.To make spelling suggestions work you need to:
- Make sure enableSpellCheck on the SearchQuery is set to true. By default it should be already set to true.
- Have indexed properties configured to be used for spellchecking.
Query Parameters
- query: (string )
Serialized query, free text search, facets.
The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 - pageSize: (string- default: 20 )
The number of results returned per page.
- sort: (string )
Sorting method applied to the display search results.
- currentPage: (string )
The current result page requested.
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ProductSearchPageWsDTO",
"type": "object",
"description": "POJO containing the result page for product search.",
"properties":
{
"freeTextSearch":
{
"type": "string"
},
"categoryCode":
{
"type": "string"
},
"keywordRedirectUrl":
{
"type": "string"
},
"spellingSuggestion":
{
"$ref": "#/definitions/SpellingSuggestionWsDTO"
},
"products":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductWsDTO"
}
},
"sorts":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SortWsDTO"
}
},
"pagination":
{
"$ref": "#/definitions/PaginationWsDTO"
},
"currentQuery":
{
"$ref": "#/definitions/SearchStateWsDTO"
},
"breadcrumbs":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BreadcrumbWsDTO"
}
},
"facets":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FacetWsDTO"
}
}
},
"definitions":
{
"SpellingSuggestionWsDTO":
{
"properties":
{
"suggestion":
{
"type": "string"
},
"query":
{
"type": "string"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"SortWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"selected":
{
"type": "boolean"
}
}
},
"PaginationWsDTO":
{
"properties":
{
"totalPages":
{
"description": "The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.",
"type": "number"
},
"totalResults":
{
"description": "The total number of matched results across all pages.",
"type": "number"
},
"pageSize":
{
"description": "The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results.",
"type": "number"
},
"currentPage":
{
"description": "The current page number. The first page is number zero (0), the second page is number one (1), and so on.",
"type": "number"
},
"sort":
{
"description": "The selected sort code.",
"type": "string"
}
}
},
"SearchStateWsDTO":
{
"properties":
{
"url":
{
"type": "string"
},
"query":
{
"$ref": "#/definitions/SearchQueryWsDTO"
}
}
},
"BreadcrumbWsDTO":
{
"properties":
{
"facetCode":
{
"type": "string"
},
"facetName":
{
"type": "string"
},
"facetValueCode":
{
"type": "string"
},
"facetValueName":
{
"type": "string"
},
"removeQuery":
{
"$ref": "#/definitions/SearchStateWsDTO"
},
"truncateQuery":
{
"$ref": "#/definitions/SearchStateWsDTO"
}
}
},
"FacetWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"priority":
{
"type": "number"
},
"category":
{
"type": "boolean"
},
"multiSelect":
{
"type": "boolean"
},
"visible":
{
"type": "boolean"
},
"topValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FacetValueWsDTO"
}
},
"values":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FacetValueWsDTO"
}
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"SearchQueryWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"FacetValueWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"count":
{
"type": "number"
},
"query":
{
"$ref": "#/definitions/SearchStateWsDTO"
},
"selected":
{
"type": "boolean"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
get
Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.
get /products/suggestions
Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.
Query Parameters
- max: required (string- default: 10 )
Specifies the limit of results.
- term: required (string )
Specified term
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "SuggestionListWsDTO",
"type": "object",
"properties":
{
"suggestions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SuggestionWsDTO"
}
}
},
"definitions":
{
"SuggestionWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
}
}
}
get
Returns details of a single product according to a product code.
get /products/{productCode}
Returns details of a single product according to a product code.
URI Parameters
- productCode: required (string )
Product identifier
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ProductWsDTO",
"type": "object",
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
},
"definitions":
{
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
get
Returns references for a product with a given product code. Reference type specifies which references to return.
Security: Permitted only for trusted client
get /products/{productCode}/references
Returns references for a product with a given product code. Reference type specifies which references to return.
Security: Permitted only for trusted client
URI Parameters
- productCode: required (string )
Product identifier
Query Parameters
- pageSize: (string- default: 2147483647 )
Maximum size of returned results.
- referenceType: (string )
Reference type according to enum ProductReferenceTypeEnum
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ProductReferenceListWsDTO",
"type": "object",
"properties":
{
"references":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
}
},
"definitions":
{
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
get
Returns the reviews for a product with a given product code.
post
Creates a new customer review as an anonymous user.
get /products/{productCode}/reviews
Returns the reviews for a product with a given product code.
URI Parameters
- productCode: required (string )
Product identifier
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ReviewListWsDTO",
"type": "object",
"properties":
{
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
}
},
"definitions":
{
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
post /products/{productCode}/reviews
Creates a new customer review as an anonymous user.
URI Parameters
- productCode: required (string )
Product identifier
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- rating: (string )
This parameter is required. Value needs to be between 1 and 5.
- alias: (string )
- comment: (string )
This parameter is required.
- headline: (string )
This parameter is required.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ReviewWsDTO",
"type": "object",
"properties":
{
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
}
}
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "ReviewWsDTO",
"type": "object",
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
},
"definitions":
{
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
head
Returns X-Total-Count header with a total number of product's stock levels. It does not return the HTTP body. The following two sets of parameters are available:
- location (required) or
- longitude (required), latitude (required).
get
Returns product's stock levels sorted by distance from specific location passed by free-text parameter or longitude and latitude parameters. The following two sets of parameters are available:
- location (required), currentPage (optional), pageSize (optional) or >
- longitude (required), latitude (required), currentPage (optional), pageSize(optional).
head /products/{productCode}/stock
Returns X-Total-Count header with a total number of product's stock levels. It does not return the HTTP body. The following two sets of parameters are available:
- location (required) or
- longitude (required), latitude (required).
URI Parameters
- productCode: required (string )
Product identifier
Query Parameters
- latitude: (string )
Longitude location parameter.
- location: (string )
Free-text location
- longitude: (string )
Latitude location parameter.
HTTP status code 200
get /products/{productCode}/stock
Returns product's stock levels sorted by distance from specific location passed by free-text parameter or longitude and latitude parameters. The following two sets of parameters are available:
- location (required), currentPage (optional), pageSize (optional) or >
- longitude (required), latitude (required), currentPage (optional), pageSize(optional).
URI Parameters
- productCode: required (string )
Product identifier
Query Parameters
- latitude: (string )
Longitude location parameter.
- pageSize: (string- default: 20 )
The number of results returned per page.
- location: (string )
Free-text location
- currentPage: (string )
The current result page requested.
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
- longitude: (string )
Latitude location parameter.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "StoreFinderStockSearchPageWsDTO",
"type": "object",
"properties":
{
"stores":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PointOfServiceStockWsDTO"
}
},
"sorts":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SortWsDTO"
}
},
"pagination":
{
"$ref": "#/definitions/PaginationWsDTO"
},
"locationText":
{
"type": "string"
},
"sourceLatitude":
{
"type": "number"
},
"sourceLongitude":
{
"type": "number"
},
"boundNorthLatitude":
{
"type": "number"
},
"boundEastLongitude":
{
"type": "number"
},
"boundSouthLatitude":
{
"type": "number"
},
"boundWestLongitude":
{
"type": "number"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
}
},
"definitions":
{
"PointOfServiceStockWsDTO":
{
"properties":
{
"stockInfo":
{
"$ref": "#/definitions/StockWsDTO"
},
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"SortWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"selected":
{
"type": "boolean"
}
}
},
"PaginationWsDTO":
{
"properties":
{
"totalPages":
{
"description": "The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.",
"type": "number"
},
"totalResults":
{
"description": "The total number of matched results across all pages.",
"type": "number"
},
"pageSize":
{
"description": "The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results.",
"type": "number"
},
"currentPage":
{
"description": "The current page number. The first page is number zero (0), the second page is number one (1), and so on.",
"type": "number"
},
"sort":
{
"description": "The selected sort code.",
"type": "string"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
}
}
}
get
Returns product's stock level for a particular store (POS).
get /products/{productCode}/stock/{storeName}
Returns product's stock level for a particular store (POS).
URI Parameters
- productCode: required (string )
Product identifier
- storeName: required (string )
Store identifier
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "StockWsDTO",
"type": "object",
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
},
"definitions":
{
}
}
/promotions
get
Returns promotions defined for a current base site.
Security: Permitted only for trusted client
get /promotions
Returns promotions defined for a current base site.
Security: Permitted only for trusted client
Query Parameters
- promotionGroup: (string )
Only promotions from this group are returned
- type: (string )
Defines what type of promotions should be returned. Values supported for that parameter are:
- all: All available promotions are returned
- product: Only product promotions are returned
- order: Only order promotions are returned
- fields: (string- default: BASIC )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PromotionListWsDTO",
"type": "object",
"properties":
{
"promotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
}
},
"definitions":
{
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
}
}
}
get
Returns details of a single promotion specified by a promotion code.
Security: Permitted only for trusted client
get /promotions/{code}
Returns details of a single promotion specified by a promotion code.
Security: Permitted only for trusted client
URI Parameters
- code: required (string )
Promotion identifier (code)
Query Parameters
- fields: (string- default: BASIC )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PromotionWsDTO",
"type": "object",
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
},
"definitions":
{
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
}
}
}
/stores
head
Returns X-Total-Count header with the number of all store locations that are near the location specified in a query, or based on latitude and longitude.
get
Lists all store locations that are near the location specified in a query or based on latitude and longitude.
head /stores
Returns X-Total-Count header with the number of all store locations that are near the location specified in a query, or based on latitude and longitude.
Query Parameters
- query: (string )
Location in natural language i.e. city or country.
- latitude: (string )
Coordinate that specifies the north-south position of a point on the Earth's surface.
- accuracy: (string )
Accuracy in meters.
- radius: (string- default: 100000 )
Radius in meters. Max value: 40075000.0 (Earth's perimeter).
- longitude: (string )
Coordinate that specifies the east-west position of a point on the Earth's surface.
HTTP status code 200
get /stores
Lists all store locations that are near the location specified in a query or based on latitude and longitude.
Query Parameters
- query: (string )
Location in natural language i.e. city or country.
- latitude: (string )
Coordinate that specifies the north-south position of a point on the Earth's surface.
- pageSize: (string- default: 20 )
The number of results returned per page.
- accuracy: (string )
Accuracy in meters.
- sort: (string- default: asc )
Sorting method applied to the return results.
- currentPage: (string )
The current result page requested.
- radius: (string- default: 100000 )
Radius in meters. Max value: 40075000.0 (Earth's perimeter).
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
- longitude: (string )
Coordinate that specifies the east-west position of a point on the Earth's surface.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "StoreFinderSearchPageWsDTO",
"type": "object",
"properties":
{
"stores":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
},
"sorts":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SortWsDTO"
}
},
"pagination":
{
"$ref": "#/definitions/PaginationWsDTO"
},
"locationText":
{
"type": "string"
},
"sourceLatitude":
{
"type": "number"
},
"sourceLongitude":
{
"type": "number"
},
"boundNorthLatitude":
{
"type": "number"
},
"boundEastLongitude":
{
"type": "number"
},
"boundSouthLatitude":
{
"type": "number"
},
"boundWestLongitude":
{
"type": "number"
}
},
"definitions":
{
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"SortWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"selected":
{
"type": "boolean"
}
}
},
"PaginationWsDTO":
{
"properties":
{
"totalPages":
{
"description": "The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.",
"type": "number"
},
"totalResults":
{
"description": "The total number of matched results across all pages.",
"type": "number"
},
"pageSize":
{
"description": "The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results.",
"type": "number"
},
"currentPage":
{
"description": "The current page number. The first page is number zero (0), the second page is number one (1), and so on.",
"type": "number"
},
"sort":
{
"description": "The selected sort code.",
"type": "string"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
get
Returns store location based on its unique name.
get /stores/{storeId}
Returns store location based on its unique name.
URI Parameters
- storeId: required (string )
Store identifier (currently store name)
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PointOfServiceWsDTO",
"type": "object",
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"definitions":
{
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
/titles
get
Lists all localized titles.
get /titles
Lists all localized titles.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "TitleListWsDTO",
"type": "object",
"properties":
{
"titles":
{
"type": "array",
"items":
{
"$ref": "#/definitions/TitleWsDTO"
}
}
},
"definitions":
{
"TitleWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
/users
post
Registers a customer. The following two sets of parameters are available:
- First set is used to register a customer. In this case the required parameters are: login, password, firstName, lastName, titleCode.
- Second set is used to convert a guest to a customer. In this case the required parameters are: guid, password.
Security: Permitted only for customer managers, clients or trusted clients.
post /users
Registers a customer. The following two sets of parameters are available:
- First set is used to register a customer. In this case the required parameters are: login, password, firstName, lastName, titleCode.
- Second set is used to convert a guest to a customer. In this case the required parameters are: guid, password.
Security: Permitted only for customer managers, clients or trusted clients.
Body
Type: application/x-www-form-urlencoded
Form Parameters- firstName: (string )
Customer's first name.
- lastName: (string )
Customer's last name.
- password: (string )
Customer's password.
- guid: (string )
Guest order's guid.
- login: (string )
Customer's login. Customer login is case insensitive.
- titleCode: (string )
Customer's title code. For a list of codes, see /{baseSiteId}/titles resource
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserSignUpWsDTO",
"type": "object",
"properties":
{
"uid":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"password":
{
"type": "string"
}
}
}
HTTP status code 201
get
Returns customer profile.
Security: Permitted for clients, customers and customer managers
put
Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
patch
Updates customer profile. Only attributes provided in the request body will be changed.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
delete
Removes customer profile.
Security: Permitted for trusted clients, customers and customer managers. Trusted client is able to impersonate as any other user and deactivate profile on their behalf.
get /users/{userId}
Returns customer profile.
Security: Permitted for clients, customers and customer managers
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in the response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserWsDTO",
"type": "object",
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
},
"definitions":
{
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
put /users/{userId}
Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Body
Type: application/x-www-form-urlencoded
Form Parameters- firstName: (string )
Customer's first name.
- lastName: (string )
Customer's last name.
- language: (string )
Customer's language.
- currency: (string )
Customer's currency.
- titleCode: required (string )
Customer's title code. For a list of codes, see /{baseSiteId}/titles resource
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserWsDTO",
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"language":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
patch /users/{userId}
Updates customer profile. Only attributes provided in the request body will be changed.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change profile on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Body
Type: application/x-www-form-urlencoded
Form Parameters- firstName: (string )
Customer's first name.
- lastName: (string )
Customer's last name.
- language: (string )
Customer's language.
- currency: (string )
Customer's currency.
- titleCode: (string )
Customer's title code. For a list of codes, see /{baseSiteId}/titles resource
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserWsDTO",
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"language":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
delete /users/{userId}
Removes customer profile.
Security: Permitted for trusted clients, customers and customer managers. Trusted client is able to impersonate as any other user and deactivate profile on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
HTTP status code 200
get
Returns customer's addresses.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
post
Created a new address.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
get /users/{userId}/addresses
Returns customer's addresses.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in the response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressListWsDTO",
"type": "object",
"properties":
{
"addresses":
{
"type": "array",
"items":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"definitions":
{
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
post /users/{userId}/addresses
Created a new address.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- region.isocode: (string )
Isocode for region. If this parameter is required depends on country.
- firstName: (string )
Customer's first name. This parameter is required.
- lastName: (string )
Customer's last name. This parameter is required.
- town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required)
- line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- titleCode: (string )
Customer's title code. This parameter is required. For a list of codes, see /{baseSiteId}/titles resource
- line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- country.isocode: (string )
Country isocode. This parameter is required and have influence on how rest of parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
},
"definitions":
{
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
post
Verifies address
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
post /users/{userId}/addresses/verification
Verifies address
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in the response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- region.isocode: (string )
Isocode for region. If this parameter is required depends on country.
- town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required)
- line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- country.isocode: (string )
Country isocode. This parameter is required and have influence on how rest of parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressValidationWsDTO",
"type": "object",
"properties":
{
"errors":
{
"$ref": "#/definitions/ErrorListWsDTO"
},
"decision":
{
"type": "string"
},
"suggestedAddresses":
{
"type": "array",
"items":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"definitions":
{
"ErrorListWsDTO":
{
"properties":
{
"errors":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ErrorWsDTO"
}
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"ErrorWsDTO":
{
"properties":
{
"type":
{
"description": "Type of the error e.g. 'LowStockError'.",
"type": "string"
},
"reason":
{
"description": "Additional classification specific for each error type e.g. 'noStock'.",
"type": "string"
},
"message":
{
"description": "Descriptive, human readable error message.",
"type": "string"
},
"subjectType":
{
"description": "Type of the object related to the error e.g. 'entry'.",
"type": "string"
},
"subject":
{
"description": "Identifier of the related object e.g. '1'.",
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
get
Returns detailed information about address with a given id.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
put
Updates the address. Attributes not provided in the request will be defined again (set to null or default).
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
patch
Updates the address. Only attributes provided in the request body will be changed.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
delete
Removes customer's address.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
get /users/{userId}/addresses/{addressId}
Returns detailed information about address with a given id.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- addressId: required (string )
Address identifier
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in the response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
},
"definitions":
{
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
put /users/{userId}/addresses/{addressId}
Updates the address. Attributes not provided in the request will be defined again (set to null or default).
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- addressId: required (string )
Address identifier
Body
Type: application/x-www-form-urlencoded
Form Parameters- firstName: (string )
Customer's first name. This parameter is required.
- lastName: (string )
Customer's last name. This parameter is required.
- country: (string )
.isocode Country isocode. This parameter is required and have influence on how rest of parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
- town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required) restparam region .isocode Isocode for region. If this parameter is required depends on country.
- line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- titleCode: (string )
Customer's title code. This parameter is required. For a list of codes, see /{baseSiteId}/titles resource
- line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- defaultAddress: (string )
Parameter specifies if address should be default for customer
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
patch /users/{userId}/addresses/{addressId}
Updates the address. Only attributes provided in the request body will be changed.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- addressId: required (string )
Address identifier
Body
Type: application/x-www-form-urlencoded
Form Parameters- region.isocode: (string )
ISO code for region. If this parameter is required depends on country.
- firstName: (string )
Customer's first name. This parameter is required.
- lastName: (string )
Customer's last name. This parameter is required.
- town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required)
- line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- titleCode: (string )
Customer's title code. This parameter is required. For a list of codes, see /{baseSiteId}/titles resource
- line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- country.isocode: (string )
Country isocode. This parameter is required and have influence on how rest of parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
- defaultAddress: (string )
Parameter specifies if address should be default for customer
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
delete /users/{userId}/addresses/{addressId}
Removes customer's address.
Security: Permitted for customers, guests, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- addressId: required (string )
Address identifier
HTTP status code 200
get
Lists all customer carts.
Security: Permitted only for non-anonymous users.
post
Creates a new cart or restores an anonymous cart as a user's cart (if an old Cart Id is given in the request)
Security: Cart may be created by everybody. Restoring anonymous carts is permitted only for non anonymous users.
get /users/{userId}/carts
Lists all customer carts.
Security: Permitted only for non-anonymous users.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response).
Body
Type: application/x-www-form-urlencoded
Form Parameters- savedCartsOnly: (string )
optional parameter. If the parameter is provided and its value is true only saved carts are returned.
- pageSize: (string- default: 20 )
optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.
- sort: (string )
optional sort criterion in case of savedCartsOnly == true. No default value.
- currentPage: (string )
optional pagination parameter in case of savedCartsOnly == true. Default value 0.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CartListWsDTO",
"type": "object",
"properties":
{
"carts":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CartWsDTO"
}
}
},
"definitions":
{
"CartWsDTO":
{
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
post /users/{userId}/carts
Creates a new cart or restores an anonymous cart as a user's cart (if an old Cart Id is given in the request)
Security: Cart may be created by everybody. Restoring anonymous carts is permitted only for non anonymous users.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- toMergeCartGuid: (string )
User's cart GUID to merge anonymous cart to
- oldCartId: (string )
Anonymous cart GUID
HTTP status code 201
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CartWsDTO",
"type": "object",
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
},
"definitions":
{
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
get
Returns the cart with a given identifier.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
delete
Deletes a cart with a given cart id.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
get /users/{userId}/carts/{cartId}
Returns the cart with a given identifier.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CartWsDTO",
"type": "object",
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
},
"definitions":
{
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
delete /users/{userId}/carts/{cartId}
Deletes a cart with a given cart id.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
HTTP status code 200
post
Creates an address and assigns it to the cart as the delivery address.
Security: Permitted only for guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
put
Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
delete
Removes the delivery address from the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
post /users/{userId}/carts/{cartId}/addresses/delivery
Creates an address and assigns it to the cart as the delivery address.
Security: Permitted only for guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- region.isocode: (string )
Isocode for region. If this parameter is required depends on country.
- firstName: (string )
Customer's first name. This parameter is required.
- lastName: (string )
Customer's last name. This parameter is required.
- town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required)
- line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- titleCode: (string )
Customer's title code. This parameter is required. For a list of codes, see /{baseSiteId}/titles resource
- line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- country.isocode: (string )
Country isocode. This parameter is required and have influence on how rest of parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "AddressWsDTO",
"type": "object",
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
},
"definitions":
{
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
put /users/{userId}/carts/{cartId}/addresses/delivery
Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Body
Type: application/x-www-form-urlencoded
Form Parameters- addressId: required (string )
Address identifier
HTTP status code 200
delete /users/{userId}/carts/{cartId}/addresses/delivery
Removes the delivery address from the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
HTTP status code 200
post
Explicitly clones a cart
post /users/{userId}/carts/{cartId}/clonesavedcart
Explicitly clones a cart
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- name: (string )
the name that should be applied to the cloned cart
- description: (string )
the description that should be applied to the cloned cart
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "SaveCartResultWsDTO",
"type": "object",
"properties":
{
"savedCartData":
{
"$ref": "#/definitions/CartWsDTO"
}
},
"definitions":
{
"CartWsDTO":
{
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
get
Returns the delivery mode selected for the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
put
Sets the delivery mode with a given identifier for the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
delete
Removes the delivery mode from the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
get /users/{userId}/carts/{cartId}/deliverymode
Returns the delivery mode selected for the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "DeliveryModeWsDTO",
"type": "object",
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"definitions":
{
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
}
}
}
put /users/{userId}/carts/{cartId}/deliverymode
Sets the delivery mode with a given identifier for the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Body
Type: application/x-www-form-urlencoded
Form Parameters- deliveryModeId: required (string )
Delivery mode identifier (code)
HTTP status code 200
delete /users/{userId}/carts/{cartId}/deliverymode
Removes the delivery mode from the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
HTTP status code 200
get
Returns all delivery modes supported for the current base store and cart delivery address. A delivery address must be set for the cart, otherwise an empty list will be returned.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
get /users/{userId}/carts/{cartId}/deliverymodes
Returns all delivery modes supported for the current base store and cart delivery address. A delivery address must be set for the cart, otherwise an empty list will be returned.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "DeliveryModeListWsDTO",
"type": "object",
"properties":
{
"deliveryModes":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
}
}
},
"definitions":
{
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
}
}
}
put
Assigns an email to the cart. This step is required to make a guest checkout.
Security: Permitted only for client or trusted client
put /users/{userId}/carts/{cartId}/email
Assigns an email to the cart. This step is required to make a guest checkout.
Security: Permitted only for client or trusted client
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Body
Type: application/x-www-form-urlencoded
Form Parameters- email: (string )
Email of the guest user. It will be used during checkout process
HTTP status code 200
get
Returns cart entries.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
post
Adds a product to the cart.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
get /users/{userId}/carts/{cartId}/entries
Returns cart entries.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderEntryListWsDTO",
"type": "object",
"properties":
{
"orderEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
}
},
"definitions":
{
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
post /users/{userId}/carts/{cartId}/entries
Adds a product to the cart.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- code: required (string )
Code of the product to be added to cart. Product look-up is performed for the current product catalog version.
- qty: (string- default: 1 )
Quantity of product.
- pickupStore: (string )
Name of the store where product will be picked. Set only if want to pick up from a store.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderEntryWsDTO",
"type": "object",
"properties":
{
"quantity":
{
"type": "number"
},
"product":
{
"type": "object",
"properties":
{
"code":
{
"type": "string"
}
}
},
"deliveryPointOfService":
{
"type": "object",
"properties":
{
"name":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CartModificationWsDTO",
"type": "object",
"properties":
{
"statusCode":
{
"type": "string"
},
"quantityAdded":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"entry":
{
"$ref": "#/definitions/OrderEntryWsDTO"
},
"deliveryModeChanged":
{
"type": "boolean"
},
"statusMessage":
{
"type": "string"
}
},
"definitions":
{
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
get
Returns the details of the cart entries.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
put
Updates the quantity of a single cart entry and details of the store where the cart entry will be picked. Attributes not provided in request will be defined again (set to null or default)
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
patch
Updates the quantity of a single cart entry and details of the store where the cart entry will be picked.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
delete
Deletes cart entry.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
get /users/{userId}/carts/{cartId}/entries/{entryNumber}
Returns the details of the cart entries.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
- entryNumber: required (string )
Entry number. Zero-based numbering.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderEntryWsDTO",
"type": "object",
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
},
"definitions":
{
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
put /users/{userId}/carts/{cartId}/entries/{entryNumber}
Updates the quantity of a single cart entry and details of the store where the cart entry will be picked. Attributes not provided in request will be defined again (set to null or default)
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
- entryNumber: required (string )
Entry number. Zero-based numbering.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- qty: required (string )
Quantity of product.
- pickupStore: (string )
Name of the store where product will be picked. Set only if want to pick up from a store.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderEntryWsDTO",
"type": "object",
"properties":
{
"quantity":
{
"type": "number"
},
"product":
{
"type": "object",
"properties":
{
"code":
{
"type": "string"
}
}
},
"deliveryPointOfService":
{
"type": "object",
"properties":
{
"name":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CartModificationWsDTO",
"type": "object",
"properties":
{
"statusCode":
{
"type": "string"
},
"quantityAdded":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"entry":
{
"$ref": "#/definitions/OrderEntryWsDTO"
},
"deliveryModeChanged":
{
"type": "boolean"
},
"statusMessage":
{
"type": "string"
}
},
"definitions":
{
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
patch /users/{userId}/carts/{cartId}/entries/{entryNumber}
Updates the quantity of a single cart entry and details of the store where the cart entry will be picked.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
- entryNumber: required (string )
Entry number. Zero-based numbering.
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- qty: (string )
Quantity of product.
- pickupStore: (string )
Name of the store where product will be picked. Set only if want to pick up from a store.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderEntryWsDTO",
"type": "object",
"properties":
{
"quantity":
{
"type": "number"
},
"product":
{
"type": "object",
"properties":
{
"code":
{
"type": "string"
}
}
},
"deliveryPointOfService":
{
"type": "object",
"properties":
{
"name":
{
"type": "string"
}
}
}
}
}
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "CartModificationWsDTO",
"type": "object",
"properties":
{
"statusCode":
{
"type": "string"
},
"quantityAdded":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"entry":
{
"$ref": "#/definitions/OrderEntryWsDTO"
},
"deliveryModeChanged":
{
"type": "boolean"
},
"statusMessage":
{
"type": "string"
}
},
"definitions":
{
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
delete /users/{userId}/carts/{cartId}/entries/{entryNumber}
Deletes cart entry.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
- entryNumber: required (string )
Entry number. Zero-based numbering.
HTTP status code 200
patch
Flags a cart for deletion (the cart doesn't have corresponding save cart attributes anymore). The cart is not actually deleted from the database. But with the removal of the saved cart attributes, this cart will be taken care of by the cart removal job just like any other cart.
patch /users/{userId}/carts/{cartId}/flagForDeletion
Flags a cart for deletion (the cart doesn't have corresponding save cart attributes anymore). The cart is not actually deleted from the database. But with the removal of the saved cart attributes, this cart will be taken care of by the cart removal job just like any other cart.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "SaveCartResultWsDTO",
"type": "object",
"properties":
{
"savedCartData":
{
"$ref": "#/definitions/CartWsDTO"
}
},
"definitions":
{
"CartWsDTO":
{
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
post
Defines details of a new credit card payment details and assigns the payment to the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
put
Sets credit card payment details for the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
post /users/{userId}/carts/{cartId}/paymentdetails
Defines details of a new credit card payment details and assigns the payment to the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- billingAddress.country.isocode: (string )
Country isocode. This parameter is required and have influence on how rest of address parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
- billingAddress.line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- startMonth: (string )
- saved: (string )
Parameter defines if the payment details should be saved for the customer and than could be reused for future orders.
- billingAddress.line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- billingAddress.region.isocode: (string )
Isocode for region. If this parameter is required depends on country.
- issueNumber: (string )
- cardType: (string )
Card type. This parameter is required. Call GET /{baseSiteId}/cardtypes beforehand to see what card types are supported
- expiryMonth: (string )
Month of expiry date. This parameter is required.
- startYear: (string )
- billingAddress.titleCode: (string )
Customer's title code. This parameter is required. For a list of codes, see /{baseSiteId}/titles resource
- defaultPaymentInfo: (string )
Parameter defines if the payment details should be used as default for customer.
- expiryYear: (string )
Year of expiry date. This parameter is required.
- accountHolderName: (string )
Name on card. This parameter is required.
- billingAddress.postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required)
- billingAddress.lastName: (string )
Customer's last name. This parameter is required.
- billingAddress.town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- subscriptionId: (string )
- cardNumber: (string )
Card number. This parameter is required.
- billingAddress.firstName: (string )
Customer's first name. This parameter is required.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PaymentDetailsWsDTO",
"type": "object",
"properties":
{
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"type": "object",
"properties":
{
}
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"billingAddress":
{
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
}
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PaymentDetailsWsDTO",
"type": "object",
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
},
"definitions":
{
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
put /users/{userId}/carts/{cartId}/paymentdetails
Sets credit card payment details for the cart.
Security: Permitted only for customers, guests, customer managers or trusted clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Body
Type: application/x-www-form-urlencoded
Form Parameters- paymentDetailsId: required (string )
Payment details identifier
HTTP status code 200
get
Return information about promotions applied on cart
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
post
Enables the promotion for the order based on the promotionId defined for the cart.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
get /users/{userId}/carts/{cartId}/promotions
Return information about promotions applied on cart
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PromotionResultListWsDTO",
"type": "object",
"properties":
{
"promotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
}
},
"definitions":
{
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
}
}
}
post /users/{userId}/carts/{cartId}/promotions
Enables the promotion for the order based on the promotionId defined for the cart.
Security: Anonymous user may access cart by its guid. Customer may access only own cart by its id. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Body
Type: application/x-www-form-urlencoded
Form Parameters- promotionId: required (string )
Promotion identifier
HTTP status code 200
get
Return information about promotion with given id, applied on cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
delete
Disables the promotion for the order based on the promotionId defined for the cart.
Security: Permitted only for trusted clients
get /users/{userId}/carts/{cartId}/promotions/{promotionId}
Return information about promotion with given id, applied on cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
- promotionId: required (string )
Promotion identifier (code)
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PromotionResultListWsDTO",
"type": "object",
"properties":
{
"promotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
}
},
"definitions":
{
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
}
}
}
delete /users/{userId}/carts/{cartId}/promotions/{promotionId}
Disables the promotion for the order based on the promotionId defined for the cart.
Security: Permitted only for trusted clients
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
- promotionId: required (string )
Promotion identifier (code)
HTTP status code 200
patch
patch /users/{userId}/carts/{cartId}/restoresavedcart
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "SaveCartResultWsDTO",
"type": "object",
"properties":
{
"savedCartData":
{
"$ref": "#/definitions/CartWsDTO"
}
},
"definitions":
{
"CartWsDTO":
{
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
patch
Explicitly saves a cart
patch /users/{userId}/carts/{cartId}/save
Explicitly saves a cart
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- saveCartName: (string )
the name that should be applied to the saved cart
- saveCartDescription: (string )
the description that should be applied to the saved cart
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "SaveCartResultWsDTO",
"type": "object",
"properties":
{
"savedCartData":
{
"$ref": "#/definitions/CartWsDTO"
}
},
"definitions":
{
"CartWsDTO":
{
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
get
Returns saved cart by it id for authenticated user
get /users/{userId}/carts/{cartId}/savedcart
Returns saved cart by it id for authenticated user
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "SaveCartResultWsDTO",
"type": "object",
"properties":
{
"savedCartData":
{
"$ref": "#/definitions/CartWsDTO"
}
},
"definitions":
{
"CartWsDTO":
{
"properties":
{
"totalUnitCount":
{
"type": "number"
},
"potentialOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"potentialProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"expirationTime":
{
"type": "string"
},
"saveTime":
{
"type": "string"
},
"savedBy":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
}
}
}
get
Returns list of vouchers applied to the cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
post
Applies a voucher based on the voucherId defined for the cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
get /users/{userId}/carts/{cartId}/vouchers
Returns list of vouchers applied to the cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "VoucherListWsDTO",
"type": "object",
"properties":
{
"vouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
}
},
"definitions":
{
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
}
}
}
post /users/{userId}/carts/{cartId}/vouchers
Applies a voucher based on the voucherId defined for the cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
Body
Type: application/x-www-form-urlencoded
Form Parameters- voucherId: required (string )
Voucher identifier
HTTP status code 200
delete
Removes a voucher based on the voucherId defined for the current cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
delete /users/{userId}/carts/{cartId}/vouchers/{voucherId}
Removes a voucher based on the voucherId defined for the current cart.
Security: Permitted only for non anonymous users or clients. Trusted client or customer manager may impersonate as any user and access cart on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- cartId: required (string )
Cart identifier
- cart code for logged in user
- cart guid for anonymous user
- 'current' for the last modified cart
- voucherId: required (string )
Voucher identifier (code)
HTTP status code 200
get
Returns all customer groups of a customer.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
get /users/{userId}/customergroups
Returns all customer groups of a customer.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in the response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "UserGroupListWsDTO",
"type": "object",
"properties":
{
"userGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/UserGroupWsDTO"
}
},
"totalNumber":
{
"type": "number"
},
"pageSize":
{
"type": "number"
},
"numberOfPages":
{
"type": "number"
},
"currentPage":
{
"type": "number"
}
},
"definitions":
{
"UserGroupWsDTO":
{
"properties":
{
"members":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PrincipalWsDTO"
}
},
"subGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/UserGroupWsDTO"
}
},
"membersCount":
{
"type": "number"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
put
Changes customer's login.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change login on their behalf.
put /users/{userId}/login
Changes customer's login.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager is able to impersonate as any other user and change login on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Body
Type: application/x-www-form-urlencoded
Form Parameters- password: (string )
Customer's current password.
- newLogin: (string )
Customer's new login. Customer login is case insensitive.
HTTP status code 200
head
Returns X-Total-Count header with a total number of results (orders history for all orders placed by the specific user for the specific base store).
Security: Allowed only for customers, customer managers, trusted clients. Trusted client is able to impersonate as any customer and access their orders.
get
Returns order history data for all orders placed by the specific user for the specific base store. Response contains orders search result displayed in several pages if needed.
Security: Allowed only for customers, customer managers, trusted clients Trusted client is able to impersonate as any customer and access their orders.
post
Authorizes cart and places the order. Response contains the new order data.
Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and place order on his behalf
head /users/{userId}/orders
Returns X-Total-Count header with a total number of results (orders history for all orders placed by the specific user for the specific base store).
Security: Allowed only for customers, customer managers, trusted clients. Trusted client is able to impersonate as any customer and access their orders.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- statuses: (string )
Filters only certain order statuses. It means: statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.
HTTP status code 200
get /users/{userId}/orders
Returns order history data for all orders placed by the specific user for the specific base store. Response contains orders search result displayed in several pages if needed.
Security: Allowed only for customers, customer managers, trusted clients Trusted client is able to impersonate as any customer and access their orders.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- statuses: (string )
Filters only certain order statuses. It means: statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID.
- pageSize: (string- default: 20 )
The number of results returned per page.
- sort: (string )
Sorting method applied to the return results.
- currentPage: (string )
The current result page requested.
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderHistoryListWsDTO",
"type": "object",
"properties":
{
"orders":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderHistoryWsDTO"
}
},
"sorts":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SortWsDTO"
}
},
"pagination":
{
"$ref": "#/definitions/PaginationWsDTO"
}
},
"definitions":
{
"OrderHistoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"status":
{
"type": "string"
},
"statusDisplay":
{
"type": "string"
},
"placed":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"total":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"SortWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"selected":
{
"type": "boolean"
}
}
},
"PaginationWsDTO":
{
"properties":
{
"totalPages":
{
"description": "The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.",
"type": "number"
},
"totalResults":
{
"description": "The total number of matched results across all pages.",
"type": "number"
},
"pageSize":
{
"description": "The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results.",
"type": "number"
},
"currentPage":
{
"description": "The current page number. The first page is number zero (0), the second page is number one (1), and so on.",
"type": "number"
},
"sort":
{
"description": "The selected sort code.",
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
}
}
}
post /users/{userId}/orders
Authorizes cart and places the order. Response contains the new order data.
Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and place order on his behalf
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
Body
Type: application/x-www-form-urlencoded
Form Parameters- cartId: required (string )
Cart code for logged in user, cart GUID for guest checkout
- securityCode: (string )
CCV security code.
HTTP status code 201
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderWsDTO",
"type": "object",
"properties":
{
"created":
{
"type": "string"
},
"status":
{
"type": "string"
},
"statusDisplay":
{
"type": "string"
},
"guestCustomer":
{
"type": "boolean"
},
"consignments":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ConsignmentWsDTO"
}
},
"deliveryStatus":
{
"type": "string"
},
"deliveryStatusDisplay":
{
"type": "string"
},
"unconsignedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
},
"definitions":
{
"ConsignmentWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"trackingID":
{
"type": "string"
},
"status":
{
"type": "string"
},
"statusDate":
{
"type": "string"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ConsignmentEntryWsDTO"
}
},
"shippingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"ConsignmentEntryWsDTO":
{
"properties":
{
"orderEntry":
{
"$ref": "#/definitions/OrderEntryWsDTO"
},
"quantity":
{
"type": "number"
},
"shippedQuantity":
{
"type": "number"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
}
}
}
get
Returns specific order details based on a specific order code. The response contains detailed order information.
Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and access their orders.
get /users/{userId}/orders/{code}
Returns specific order details based on a specific order code. The response contains detailed order information.
Security: Allowed only for customers, customer managers, clients or trusted clients. Trusted client is able to impersonate as any customer and access their orders.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- code: required (string )
Order GUID (Globally Unique Identifier) or order CODE
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "OrderWsDTO",
"type": "object",
"properties":
{
"created":
{
"type": "string"
},
"status":
{
"type": "string"
},
"statusDisplay":
{
"type": "string"
},
"guestCustomer":
{
"type": "boolean"
},
"consignments":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ConsignmentWsDTO"
}
},
"deliveryStatus":
{
"type": "string"
},
"deliveryStatusDisplay":
{
"type": "string"
},
"unconsignedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"code":
{
"type": "string"
},
"net":
{
"type": "boolean"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"subTotal":
{
"$ref": "#/definitions/PriceWsDTO"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"totalItems":
{
"type": "number"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"paymentInfo":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
},
"appliedOrderPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"appliedProductPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionResultWsDTO"
}
},
"productDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"orderDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalDiscounts":
{
"$ref": "#/definitions/PriceWsDTO"
},
"site":
{
"type": "string"
},
"store":
{
"type": "string"
},
"guid":
{
"type": "string"
},
"calculated":
{
"type": "boolean"
},
"appliedVouchers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VoucherWsDTO"
}
},
"user":
{
"$ref": "#/definitions/PrincipalWsDTO"
},
"pickupOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PickupOrderEntryGroupWsDTO"
}
},
"deliveryOrderGroups":
{
"type": "array",
"items":
{
"$ref": "#/definitions/DeliveryOrderEntryGroupWsDTO"
}
},
"pickupItemsQuantity":
{
"type": "number"
},
"deliveryItemsQuantity":
{
"type": "number"
}
},
"definitions":
{
"ConsignmentWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"trackingID":
{
"type": "string"
},
"status":
{
"type": "string"
},
"statusDate":
{
"type": "string"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ConsignmentEntryWsDTO"
}
},
"shippingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"OrderEntryWsDTO":
{
"properties":
{
"entryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
},
"basePrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"totalPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"product":
{
"$ref": "#/definitions/ProductWsDTO"
},
"updateable":
{
"type": "boolean"
},
"deliveryMode":
{
"$ref": "#/definitions/DeliveryModeWsDTO"
},
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
},
"DeliveryModeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"deliveryCost":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"PromotionResultWsDTO":
{
"properties":
{
"description":
{
"type": "string"
},
"promotion":
{
"$ref": "#/definitions/PromotionWsDTO"
},
"consumedEntries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionOrderEntryConsumedWsDTO"
}
}
}
},
"VoucherWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PrincipalWsDTO":
{
"properties":
{
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PickupOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryPointOfService":
{
"$ref": "#/definitions/PointOfServiceWsDTO"
},
"distance":
{
"type": "number"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"DeliveryOrderEntryGroupWsDTO":
{
"properties":
{
"deliveryAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"totalPriceWithTax":
{
"$ref": "#/definitions/PriceWsDTO"
},
"entries":
{
"type": "array",
"items":
{
"$ref": "#/definitions/OrderEntryWsDTO"
}
},
"quantity":
{
"type": "number"
}
}
},
"ConsignmentEntryWsDTO":
{
"properties":
{
"orderEntry":
{
"$ref": "#/definitions/OrderEntryWsDTO"
},
"quantity":
{
"type": "number"
},
"shippedQuantity":
{
"type": "number"
}
}
},
"PointOfServiceWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"displayName":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"openingHours":
{
"$ref": "#/definitions/OpeningScheduleWsDTO"
},
"storeContent":
{
"type": "string"
},
"features":
{
"type": "object"
},
"geoPoint":
{
"$ref": "#/definitions/GeoPointWsDTO"
},
"formattedDistance":
{
"type": "string"
},
"distanceKm":
{
"type": "number"
},
"mapIcon":
{
"$ref": "#/definitions/ImageWsDTO"
},
"address":
{
"$ref": "#/definitions/AddressWsDTO"
},
"storeImages":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
}
},
"ProductWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"url":
{
"type": "string"
},
"description":
{
"type": "string"
},
"purchasable":
{
"type": "boolean"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"futureStocks":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FutureStockWsDTO"
}
},
"availableForPickup":
{
"type": "boolean"
},
"averageRating":
{
"type": "number"
},
"numberOfReviews":
{
"type": "number"
},
"summary":
{
"type": "string"
},
"manufacturer":
{
"type": "string"
},
"variantType":
{
"type": "string"
},
"price":
{
"$ref": "#/definitions/PriceWsDTO"
},
"baseProduct":
{
"type": "string"
},
"images":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ImageWsDTO"
}
},
"categories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/CategoryWsDTO"
}
},
"reviews":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ReviewWsDTO"
}
},
"classifications":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ClassificationWsDTO"
}
},
"potentialPromotions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionWsDTO"
}
},
"variantOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"baseOptions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/BaseOptionWsDTO"
}
},
"volumePricesFlag":
{
"type": "boolean"
},
"volumePrices":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"productReferences":
{
"type": "array",
"items":
{
"$ref": "#/definitions/ProductReferenceWsDTO"
}
},
"variantMatrix":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"priceRange":
{
"$ref": "#/definitions/PriceRangeWsDTO"
},
"multidimensional":
{
"type": "boolean"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"PromotionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"title":
{
"type": "string"
},
"promotionType":
{
"type": "string"
},
"startDate":
{
"type": "string"
},
"endDate":
{
"type": "string"
},
"description":
{
"type": "string"
},
"couldFireMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"firedMessages":
{
"type": "array",
"items":
{
"type": "string"
}
},
"productBanner":
{
"$ref": "#/definitions/ImageWsDTO"
},
"enabled":
{
"type": "boolean"
},
"priority":
{
"type": "number"
},
"promotionGroup":
{
"type": "string"
},
"restrictions":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PromotionRestrictionWsDTO"
}
}
}
},
"PromotionOrderEntryConsumedWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"adjustedUnitPrice":
{
"type": "number"
},
"orderEntryNumber":
{
"type": "number"
},
"quantity":
{
"type": "number"
}
}
},
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"OpeningScheduleWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"code":
{
"type": "string"
},
"weekDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/WeekdayOpeningDayWsDTO"
}
},
"specialDayOpeningList":
{
"type": "array",
"items":
{
"$ref": "#/definitions/SpecialOpeningDayWsDTO"
}
}
}
},
"GeoPointWsDTO":
{
"properties":
{
"latitude":
{
"type": "number"
},
"longitude":
{
"type": "number"
}
}
},
"ImageWsDTO":
{
"properties":
{
"imageType":
{
"type": "string"
},
"format":
{
"type": "string"
},
"url":
{
"type": "string"
},
"altText":
{
"type": "string"
},
"galleryIndex":
{
"type": "number"
}
}
},
"StockWsDTO":
{
"properties":
{
"stockLevelStatus":
{
"type": "string"
},
"stockLevel":
{
"type": "number"
}
}
},
"FutureStockWsDTO":
{
"properties":
{
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
}
}
},
"CategoryWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"url":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"ReviewWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"headline":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"rating":
{
"type": "number"
},
"date":
{
"type": "string"
},
"alias":
{
"type": "string"
},
"principal":
{
"$ref": "#/definitions/UserWsDTO"
}
}
},
"ClassificationWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"features":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureWsDTO"
}
}
}
},
"VariantOptionWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"stock":
{
"$ref": "#/definitions/StockWsDTO"
},
"url":
{
"type": "string"
},
"priceData":
{
"$ref": "#/definitions/PriceWsDTO"
},
"variantOptionQualifiers":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionQualifierWsDTO"
}
}
}
},
"BaseOptionWsDTO":
{
"properties":
{
"variantType":
{
"type": "string"
},
"options":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
},
"selected":
{
"$ref": "#/definitions/VariantOptionWsDTO"
}
}
},
"ProductReferenceWsDTO":
{
"properties":
{
"preselected":
{
"type": "boolean"
},
"referenceType":
{
"type": "string"
},
"description":
{
"type": "string"
},
"quantity":
{
"type": "number"
},
"target":
{
"$ref": "#/definitions/ProductWsDTO"
}
}
},
"VariantMatrixElementWsDTO":
{
"properties":
{
"variantValueCategory":
{
"$ref": "#/definitions/VariantValueCategoryWsDTO"
},
"parentVariantCategory":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
},
"variantOption":
{
"$ref": "#/definitions/VariantOptionWsDTO"
},
"elements":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantMatrixElementWsDTO"
}
},
"isLeaf":
{
"type": "boolean"
}
}
},
"PriceRangeWsDTO":
{
"properties":
{
"maxPrice":
{
"$ref": "#/definitions/PriceWsDTO"
},
"minPrice":
{
"$ref": "#/definitions/PriceWsDTO"
}
}
},
"PromotionRestrictionWsDTO":
{
"properties":
{
"restrictionType":
{
"type": "string"
},
"description":
{
"type": "string"
}
}
},
"WeekdayOpeningDayWsDTO":
{
"properties":
{
"weekDay":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"SpecialOpeningDayWsDTO":
{
"properties":
{
"date":
{
"type": "string"
},
"formattedDate":
{
"type": "string"
},
"closed":
{
"type": "boolean"
},
"name":
{
"type": "string"
},
"comment":
{
"type": "string"
},
"openingTime":
{
"$ref": "#/definitions/TimeWsDTO"
},
"closingTime":
{
"$ref": "#/definitions/TimeWsDTO"
}
}
},
"UserWsDTO":
{
"properties":
{
"defaultAddress":
{
"$ref": "#/definitions/AddressWsDTO"
},
"titleCode":
{
"type": "string"
},
"title":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"language":
{
"$ref": "#/definitions/LanguageWsDTO"
},
"displayUid":
{
"type": "string"
},
"uid":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"FeatureWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"type":
{
"type": "string"
},
"range":
{
"type": "boolean"
},
"comparable":
{
"type": "boolean"
},
"featureUnit":
{
"$ref": "#/definitions/FeatureUnitWsDTO"
},
"featureValues":
{
"type": "array",
"items":
{
"$ref": "#/definitions/FeatureValueWsDTO"
}
}
}
},
"VariantOptionQualifierWsDTO":
{
"properties":
{
"qualifier":
{
"type": "string"
},
"name":
{
"type": "string"
},
"value":
{
"type": "string"
},
"image":
{
"$ref": "#/definitions/ImageWsDTO"
}
}
},
"VariantValueCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"sequence":
{
"type": "number"
},
"superCategories":
{
"type": "array",
"items":
{
"$ref": "#/definitions/VariantCategoryWsDTO"
}
}
}
},
"VariantCategoryWsDTO":
{
"properties":
{
"name":
{
"type": "string"
},
"hasImage":
{
"type": "boolean"
},
"priority":
{
"type": "number"
}
}
},
"TimeWsDTO":
{
"properties":
{
"hour":
{
"type": "string"
},
"minute":
{
"type": "string"
},
"formattedHour":
{
"type": "string"
}
}
},
"LanguageWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"nativeName":
{
"type": "string"
},
"active":
{
"type": "boolean"
}
}
},
"FeatureUnitWsDTO":
{
"properties":
{
"symbol":
{
"type": "string"
},
"name":
{
"type": "string"
},
"unitType":
{
"type": "string"
}
}
},
"FeatureValueWsDTO":
{
"properties":
{
"value":
{
"type": "string"
}
}
}
}
}
put
Changes customer's password.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager may change someone's else password without knowing the old one.
put /users/{userId}/password
Changes customer's password.
Security: Permitted for trusted clients, customers and customer managers. Trusted client or customer manager may change someone's else password without knowing the old one.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Body
Type: application/x-www-form-urlencoded
Form Parameters- new: (string )
New password
- old: (string )
Old password. Required only for ROLE_CUSTOMERGROUP
HTTP status code 202
get
Return customer's credit card payment details list.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
get /users/{userId}/paymentdetails
Return customer's credit card payment details list.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
Query Parameters
- saved: (string )
Type of payment details
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in the response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PaymentDetailsListWsDTO",
"type": "object",
"properties":
{
"payments":
{
"type": "array",
"items":
{
"$ref": "#/definitions/PaymentDetailsWsDTO"
}
}
},
"definitions":
{
"PaymentDetailsWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
}
},
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
get
Returns customer's credit card payment details for a given id.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
put
Updates existing customer's credit card payment info based on the payment info ID. Attributes not given in request will be defined again (set to null or default).
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
patch
Updates existing customer's credit card payment details based on its ID. Only attributes given in request will be changed.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
delete
Removes customer's credit card payment details based on its ID.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
get /users/{userId}/paymentdetails/{paymentDetailsId}
Returns customer's credit card payment details for a given id.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- paymentDetailsId: required (string )
- Payment details identifier
Query Parameters
- fields: (string- default: DEFAULT )
Response configuration (list of fields, which should be returned in the response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PaymentDetailsWsDTO",
"type": "object",
"properties":
{
"id":
{
"type": "string"
},
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"$ref": "#/definitions/CardTypeWsDTO"
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"defaultPayment":
{
"type": "boolean"
},
"billingAddress":
{
"$ref": "#/definitions/AddressWsDTO"
}
},
"definitions":
{
"CardTypeWsDTO":
{
"properties":
{
"code":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"AddressWsDTO":
{
"properties":
{
"id":
{
"type": "string"
},
"title":
{
"type": "string"
},
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"companyName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"$ref": "#/definitions/RegionWsDTO"
},
"postalCode":
{
"type": "string"
},
"phone":
{
"type": "string"
},
"email":
{
"type": "string"
},
"country":
{
"$ref": "#/definitions/CountryWsDTO"
},
"shippingAddress":
{
"type": "boolean"
},
"visibleInAddressBook":
{
"type": "boolean"
},
"formattedAddress":
{
"type": "string"
}
}
},
"RegionWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"isocodeShort":
{
"type": "string"
},
"countryIso":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
},
"CountryWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
}
}
}
}
}
put /users/{userId}/paymentdetails/{paymentDetailsId}
Updates existing customer's credit card payment info based on the payment info ID. Attributes not given in request will be defined again (set to null or default).
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- paymentDetailsId: required (string )
- Payment details identifier
Body
Type: application/x-www-form-urlencoded
Form Parameters- billingAddress.country.isocode: (string )
Country isocode. This parameter is required and have influence on how rest of address parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
- billingAddress.line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- startMonth: (string )
- saved: (string )
Parameter defines if the payment details should be saved for the customer and than could be reused for future orders.
- billingAddress.line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- billingAddress.region.isocode: (string )
Isocode for region. If this parameter is required depends on country.
- issueNumber: (string )
- cardType: (string )
Card type. This parameter is required. Call GET /{baseSiteId}/cardtypes beforehand to see what card types are supported
- expiryMonth: (string )
Month of expiry date. This parameter is required.
- startYear: (string )
- billingAddress.titleCode: (string )
Customer's title code. This parameter is required. For a list of codes, see /{baseSiteId}/titles resource
- defaultPaymentInfo: (string )
Parameter defines if the payment details should be used as default for customer.
- expiryYear: (string )
Year of expiry date. This parameter is required.
- accountHolderName: (string )
Name on card. This parameter is required.
- billingAddress.postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required)
- billingAddress.lastName: (string )
Customer's last name. This parameter is required.
- billingAddress.town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- subscriptionId: (string )
- cardNumber: (string )
Card number. This parameter is required.
- billingAddress.firstName: (string )
Customer's first name. This parameter is required.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PaymentDetailsWsDTO",
"type": "object",
"properties":
{
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"type": "object",
"properties":
{
}
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"billingAddress":
{
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
}
}
HTTP status code 200
patch /users/{userId}/paymentdetails/{paymentDetailsId}
Updates existing customer's credit card payment details based on its ID. Only attributes given in request will be changed.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- paymentDetailsId: required (string )
- Payment details identifier
Body
Type: application/x-www-form-urlencoded
Form Parameters- billingAddress.country.isocode: (string )
Country isocode. This parameter is required and have influence on how rest of address parameters are validated (e.g. if parameters are required : line1,line2,town,postalCode,region.isocode)
- billingAddress.line1: (string )
First part of address. If this parameter is required depends on country (usually it is required).
- startMonth: (string )
- saved: (string )
Parameter defines if the payment details should be saved for the customer and than could be reused for future orders.
- billingAddress.line2: (string )
Second part of address. If this parameter is required depends on country (usually it is not required)
- billingAddress.region.isocode: (string )
Isocode for region. If this parameter is required depends on country.
- issueNumber: (string )
- cardType: (string )
Card type. This parameter is required. Call GET /{baseSiteId}/cardtypes beforehand to see what card types are supported
- expiryMonth: (string )
Month of expiry date. This parameter is required.
- startYear: (string )
- billingAddress.titleCode: (string )
Customer's title code. This parameter is required. For a list of codes, see /{baseSiteId}/titles resource
- defaultPaymentInfo: (string )
Parameter defines if the payment details should be used as default for customer.
- expiryYear: (string )
Year of expiry date. This parameter is required.
- accountHolderName: (string )
Name on card. This parameter is required.
- billingAddress.postalCode: (string )
Postal code. If this parameter is required depends on country (usually it is required)
- billingAddress.lastName: (string )
Customer's last name. This parameter is required.
- billingAddress.town: (string )
Town name. If this parameter is required depends on country (usually it is required)
- subscriptionId: (string )
- cardNumber: (string )
Card number. This parameter is required.
- billingAddress.firstName: (string )
Customer's first name. This parameter is required.
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "PaymentDetailsWsDTO",
"type": "object",
"properties":
{
"accountHolderName":
{
"type": "string"
},
"cardType":
{
"type": "object",
"properties":
{
}
},
"cardNumber":
{
"type": "string"
},
"startMonth":
{
"type": "string"
},
"startYear":
{
"type": "string"
},
"expiryMonth":
{
"type": "string"
},
"expiryYear":
{
"type": "string"
},
"issueNumber":
{
"type": "string"
},
"subscriptionId":
{
"type": "string"
},
"saved":
{
"type": "boolean"
},
"billingAddress":
{
"type": "object",
"properties":
{
"titleCode":
{
"type": "string"
},
"firstName":
{
"type": "string"
},
"lastName":
{
"type": "string"
},
"line1":
{
"type": "string"
},
"line2":
{
"type": "string"
},
"town":
{
"type": "string"
},
"region":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
},
"postalCode":
{
"type": "string"
},
"country":
{
"type": "object",
"properties":
{
"isocode":
{
"type": "string"
}
}
}
}
}
}
}
HTTP status code 200
delete /users/{userId}/paymentdetails/{paymentDetailsId}
Removes customer's credit card payment details based on its ID.
Security: Permitted for customers, customer managers or trusted client. Trusted client or customer manager is able to impersonate as any other user and access data on their behalf.
URI Parameters
- userId: required (string )
User identifier or one of the literals below :
- 'current' for currently authenticated user
- 'anonymous' for anonymous user
- paymentDetailsId: required (string )
- Payment details identifier
HTTP status code 200
/vouchers
get
Returns details of a single voucher according to a voucher code.
Security: Permitted only for trusted client
get /vouchers/{code}
Returns details of a single voucher according to a voucher code.
Security: Permitted only for trusted client
URI Parameters
- code: required (string )
Voucher identifier (code)
Query Parameters
- fields: (string- default: BASIC )
Response configuration (list of fields, which should be returned in response)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "VoucherWsDTO",
"type": "object",
"properties":
{
"code":
{
"type": "string"
},
"voucherCode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"description":
{
"type": "string"
},
"value":
{
"type": "number"
},
"valueFormatted":
{
"type": "string"
},
"valueString":
{
"type": "string"
},
"freeShipping":
{
"type": "boolean"
},
"currency":
{
"$ref": "#/definitions/CurrencyWsDTO"
},
"appliedValue":
{
"$ref": "#/definitions/PriceWsDTO"
}
},
"definitions":
{
"CurrencyWsDTO":
{
"properties":
{
"isocode":
{
"type": "string"
},
"name":
{
"type": "string"
},
"active":
{
"type": "boolean"
},
"symbol":
{
"type": "string"
}
}
},
"PriceWsDTO":
{
"properties":
{
"currencyIso":
{
"type": "string"
},
"value":
{
"type": "number"
},
"priceType":
{
"type": "string"
},
"formattedValue":
{
"type": "string"
},
"minQuantity":
{
"type": "number"
},
"maxQuantity":
{
"type": "number"
}
}
}
}
}