Skip to main content
API docs by Redocly

Stores (v0)

Download OpenAPI specification:Download

API to manage stores

store

Get items

query Parameters
required
object (Pageable)
predicate
required
object
target
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Create an item

Request Body schema: application/json
required
id
string
Deprecated
customerId
string
createDate
string <date-time>
Deprecated
updateDate
string <date-time>
Deprecated
modelVersion
string
Deprecated
dbVersion
integer <int64>
lastUpdateReason
string
originalId
string
name
required
string [ 1 .. 150 ] characters
displayName
required
string [ 1 .. 150 ] characters
baseProduct
string
logoStore
string
bannerInvoice
string
bannerOrderConfEmail
string
logoFavicon
string
storeWebsite
string
defaultLocale
required
string
saleLocales
Array of strings
hostnames
Array of strings unique
Deprecated
Array of objects (Route) unique
status
string
Enum: "ENABLED" "DISABLED"
object (Designs)
gtmId
string
nexwayGtmId
string
blackListedPaymentTypes
Array of strings
additionalPaymentTypes
Array of strings
blackListedCountries
Array of strings
restrictedCountries
Array of strings
fallbackCartCountry
string
forceGeoipLocalization
boolean
promoteOneClickPayment
boolean
allowOrderDetailsOnCheckoutConfirmation
boolean
allowQuotes
boolean
recipientCodeMandatory
boolean
allowMultipleDiscounts
boolean
retryPaymentValidityDuration
integer <int64> <= 90
quoteValidityDuration
integer <int64> <= 90
quoteSubscriptionValidityDuration
integer <int64> <= 90
multiplePaymentsValidityDuration
integer <int64> <= 90
targetNonRecurrentPaymentMethodsForSubscriptions
string
Enum: "NOBODY" "COMPANY" "EVERYBODY"
eligibleEndUserTypes
Array of strings
Items Enum: "RESELLER_AUTHENTICATION_REQUIRED" "BUYER_AUTHENTICATION_REQUIRED" "AUTHENTICATION_NOT_REQUIRED"
object
emailSenderOverride
string^[\w-+]+(\.[\w]+)*(@[\w-]+(\.[\w]+)*(\.[a-z]{...
object
externalContextAlias
string
externalContextGenerationParams
Array of strings unique
allowInstallments
boolean
installmentOptions
Array of integers <int32> unique [ items <int32 > ]
allowSubscriptionUpgrade
boolean
hostname
string
pathPrefix
string
object (Route)
saleLocale
string
layout
string
theme
string
deprecatedHostnames
Array of strings unique
Deprecated

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "originalId": "string",
  • "name": "string",
  • "displayName": "string",
  • "baseProduct": "string",
  • "logoStore": "string",
  • "bannerInvoice": "string",
  • "bannerOrderConfEmail": "string",
  • "logoFavicon": "string",
  • "storeWebsite": "string",
  • "defaultLocale": "string",
  • "saleLocales": [
    ],
  • "hostnames": [
    ],
  • "routes": [
    ],
  • "status": "ENABLED",
  • "designs": {
    },
  • "gtmId": "string",
  • "nexwayGtmId": "string",
  • "blackListedPaymentTypes": [
    ],
  • "additionalPaymentTypes": [
    ],
  • "blackListedCountries": [
    ],
  • "restrictedCountries": [
    ],
  • "fallbackCartCountry": "string",
  • "forceGeoipLocalization": true,
  • "promoteOneClickPayment": true,
  • "allowOrderDetailsOnCheckoutConfirmation": true,
  • "allowQuotes": true,
  • "recipientCodeMandatory": true,
  • "allowMultipleDiscounts": true,
  • "retryPaymentValidityDuration": 90,
  • "quoteValidityDuration": 90,
  • "quoteSubscriptionValidityDuration": 90,
  • "multiplePaymentsValidityDuration": 90,
  • "targetNonRecurrentPaymentMethodsForSubscriptions": "NOBODY",
  • "eligibleEndUserTypes": [
    ],
  • "thankYouDesc": {
    },
  • "emailSenderOverride": "string",
  • "localizedPaymentDescriptors": {
    },
  • "externalContextAlias": "string",
  • "externalContextGenerationParams": [
    ],
  • "allowInstallments": true,
  • "installmentOptions": [
    ],
  • "allowSubscriptionUpgrade": true,
  • "hostname": "string",
  • "pathPrefix": "string",
  • "route": {
    },
  • "saleLocale": "string",
  • "layout": "string",
  • "theme": "string",
  • "deprecatedHostnames": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "name": "string",
  • "displayName": "string",
  • "baseProduct": "string",
  • "logoStore": "string",
  • "bannerInvoice": "string",
  • "bannerOrderConfEmail": "string",
  • "logoFavicon": "string",
  • "storeWebsite": "string",
  • "defaultLocale": "string",
  • "saleLocales": [
    ],
  • "hostnames": [
    ],
  • "routes": [
    ],
  • "status": "ENABLED",
  • "designs": {
    },
  • "gtmId": "string",
  • "nexwayGtmId": "string",
  • "blackListedPaymentTypes": [
    ],
  • "additionalPaymentTypes": [
    ],
  • "blackListedCountries": [
    ],
  • "restrictedCountries": [
    ],
  • "fallbackCartCountry": "string",
  • "forceGeoipLocalization": true,
  • "promoteOneClickPayment": true,
  • "allowOrderDetailsOnCheckoutConfirmation": true,
  • "allowQuotes": true,
  • "recipientCodeMandatory": true,
  • "allowMultipleDiscounts": true,
  • "retryPaymentValidityDuration": 90,
  • "quoteValidityDuration": 90,
  • "quoteSubscriptionValidityDuration": 90,
  • "multiplePaymentsValidityDuration": 90,
  • "targetNonRecurrentPaymentMethodsForSubscriptions": "NOBODY",
  • "eligibleEndUserTypes": [
    ],
  • "thankYouDesc": {
    },
  • "emailSenderOverride": "string",
  • "localizedPaymentDescriptors": {
    },
  • "externalContextAlias": "string",
  • "externalContextGenerationParams": [
    ],
  • "allowInstallments": true,
  • "installmentOptions": [
    ],
  • "allowSubscriptionUpgrade": true,
  • "route": {
    },
  • "deprecatedHostnames": [
    ]
}

Get item

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "name": "string",
  • "displayName": "string",
  • "baseProduct": "string",
  • "logoStore": "string",
  • "bannerInvoice": "string",
  • "bannerOrderConfEmail": "string",
  • "logoFavicon": "string",
  • "storeWebsite": "string",
  • "defaultLocale": "string",
  • "saleLocales": [
    ],
  • "hostnames": [
    ],
  • "routes": [
    ],
  • "status": "ENABLED",
  • "designs": {
    },
  • "gtmId": "string",
  • "nexwayGtmId": "string",
  • "blackListedPaymentTypes": [
    ],
  • "additionalPaymentTypes": [
    ],
  • "blackListedCountries": [
    ],
  • "restrictedCountries": [
    ],
  • "fallbackCartCountry": "string",
  • "forceGeoipLocalization": true,
  • "promoteOneClickPayment": true,
  • "allowOrderDetailsOnCheckoutConfirmation": true,
  • "allowQuotes": true,
  • "recipientCodeMandatory": true,
  • "allowMultipleDiscounts": true,
  • "retryPaymentValidityDuration": 90,
  • "quoteValidityDuration": 90,
  • "quoteSubscriptionValidityDuration": 90,
  • "multiplePaymentsValidityDuration": 90,
  • "targetNonRecurrentPaymentMethodsForSubscriptions": "NOBODY",
  • "eligibleEndUserTypes": [
    ],
  • "thankYouDesc": {
    },
  • "emailSenderOverride": "string",
  • "localizedPaymentDescriptors": {
    },
  • "externalContextAlias": "string",
  • "externalContextGenerationParams": [
    ],
  • "allowInstallments": true,
  • "installmentOptions": [
    ],
  • "allowSubscriptionUpgrade": true,
  • "route": {
    },
  • "deprecatedHostnames": [
    ]
}

Update item

path Parameters
id
required
string
Request Body schema: application/json
required
id
string
Deprecated
customerId
string
createDate
string <date-time>
Deprecated
updateDate
string <date-time>
Deprecated
modelVersion
string
Deprecated
dbVersion
integer <int64>
lastUpdateReason
string
originalId
string
name
required
string [ 1 .. 150 ] characters
displayName
required
string [ 1 .. 150 ] characters
baseProduct
string
logoStore
string
bannerInvoice
string
bannerOrderConfEmail
string
logoFavicon
string
storeWebsite
string
defaultLocale
required
string
saleLocales
Array of strings
hostnames
Array of strings unique
Deprecated
Array of objects (Route) unique
status
string
Enum: "ENABLED" "DISABLED"
object (Designs)
gtmId
string
nexwayGtmId
string
blackListedPaymentTypes
Array of strings
additionalPaymentTypes
Array of strings
blackListedCountries
Array of strings
restrictedCountries
Array of strings
fallbackCartCountry
string
forceGeoipLocalization
boolean
promoteOneClickPayment
boolean
allowOrderDetailsOnCheckoutConfirmation
boolean
allowQuotes
boolean
recipientCodeMandatory
boolean
allowMultipleDiscounts
boolean
retryPaymentValidityDuration
integer <int64> <= 90
quoteValidityDuration
integer <int64> <= 90
quoteSubscriptionValidityDuration
integer <int64> <= 90
multiplePaymentsValidityDuration
integer <int64> <= 90
targetNonRecurrentPaymentMethodsForSubscriptions
string
Enum: "NOBODY" "COMPANY" "EVERYBODY"
eligibleEndUserTypes
Array of strings
Items Enum: "RESELLER_AUTHENTICATION_REQUIRED" "BUYER_AUTHENTICATION_REQUIRED" "AUTHENTICATION_NOT_REQUIRED"
object
emailSenderOverride
string^[\w-+]+(\.[\w]+)*(@[\w-]+(\.[\w]+)*(\.[a-z]{...
object
externalContextAlias
string
externalContextGenerationParams
Array of strings unique
allowInstallments
boolean
installmentOptions
Array of integers <int32> unique [ items <int32 > ]
allowSubscriptionUpgrade
boolean
hostname
string
pathPrefix
string
object (Route)
saleLocale
string
layout
string
theme
string
deprecatedHostnames
Array of strings unique
Deprecated

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "originalId": "string",
  • "name": "string",
  • "displayName": "string",
  • "baseProduct": "string",
  • "logoStore": "string",
  • "bannerInvoice": "string",
  • "bannerOrderConfEmail": "string",
  • "logoFavicon": "string",
  • "storeWebsite": "string",
  • "defaultLocale": "string",
  • "saleLocales": [
    ],
  • "hostnames": [
    ],
  • "routes": [
    ],
  • "status": "ENABLED",
  • "designs": {
    },
  • "gtmId": "string",
  • "nexwayGtmId": "string",
  • "blackListedPaymentTypes": [
    ],
  • "additionalPaymentTypes": [
    ],
  • "blackListedCountries": [
    ],
  • "restrictedCountries": [
    ],
  • "fallbackCartCountry": "string",
  • "forceGeoipLocalization": true,
  • "promoteOneClickPayment": true,
  • "allowOrderDetailsOnCheckoutConfirmation": true,
  • "allowQuotes": true,
  • "recipientCodeMandatory": true,
  • "allowMultipleDiscounts": true,
  • "retryPaymentValidityDuration": 90,
  • "quoteValidityDuration": 90,
  • "quoteSubscriptionValidityDuration": 90,
  • "multiplePaymentsValidityDuration": 90,
  • "targetNonRecurrentPaymentMethodsForSubscriptions": "NOBODY",
  • "eligibleEndUserTypes": [
    ],
  • "thankYouDesc": {
    },
  • "emailSenderOverride": "string",
  • "localizedPaymentDescriptors": {
    },
  • "externalContextAlias": "string",
  • "externalContextGenerationParams": [
    ],
  • "allowInstallments": true,
  • "installmentOptions": [
    ],
  • "allowSubscriptionUpgrade": true,
  • "hostname": "string",
  • "pathPrefix": "string",
  • "route": {
    },
  • "saleLocale": "string",
  • "layout": "string",
  • "theme": "string",
  • "deprecatedHostnames": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "name": "string",
  • "displayName": "string",
  • "baseProduct": "string",
  • "logoStore": "string",
  • "bannerInvoice": "string",
  • "bannerOrderConfEmail": "string",
  • "logoFavicon": "string",
  • "storeWebsite": "string",
  • "defaultLocale": "string",
  • "saleLocales": [
    ],
  • "hostnames": [
    ],
  • "routes": [
    ],
  • "status": "ENABLED",
  • "designs": {
    },
  • "gtmId": "string",
  • "nexwayGtmId": "string",
  • "blackListedPaymentTypes": [
    ],
  • "additionalPaymentTypes": [
    ],
  • "blackListedCountries": [
    ],
  • "restrictedCountries": [
    ],
  • "fallbackCartCountry": "string",
  • "forceGeoipLocalization": true,
  • "promoteOneClickPayment": true,
  • "allowOrderDetailsOnCheckoutConfirmation": true,
  • "allowQuotes": true,
  • "recipientCodeMandatory": true,
  • "allowMultipleDiscounts": true,
  • "retryPaymentValidityDuration": 90,
  • "quoteValidityDuration": 90,
  • "quoteSubscriptionValidityDuration": 90,
  • "multiplePaymentsValidityDuration": 90,
  • "targetNonRecurrentPaymentMethodsForSubscriptions": "NOBODY",
  • "eligibleEndUserTypes": [
    ],
  • "thankYouDesc": {
    },
  • "emailSenderOverride": "string",
  • "localizedPaymentDescriptors": {
    },
  • "externalContextAlias": "string",
  • "externalContextGenerationParams": [
    ],
  • "allowInstallments": true,
  • "installmentOptions": [
    ],
  • "allowSubscriptionUpgrade": true,
  • "route": {
    },
  • "deprecatedHostnames": [
    ]
}

Delete item

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get distinct values for a given field

query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Get recap quantities for a given field

query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Search unwind for a given field

query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

public

Get distinct values for a given field

query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Get recap quantities for a given field

query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Search unwind for a given field

query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Get items

query Parameters
required
object (Pageable)
predicate
required
object
target
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Get item

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "name": "string",
  • "displayName": "string",
  • "baseProduct": "string",
  • "logoStore": "string",
  • "bannerInvoice": "string",
  • "bannerOrderConfEmail": "string",
  • "logoFavicon": "string",
  • "storeWebsite": "string",
  • "defaultLocale": "string",
  • "saleLocales": [
    ],
  • "hostnames": [
    ],
  • "routes": [
    ],
  • "status": "ENABLED",
  • "designs": {
    },
  • "gtmId": "string",
  • "nexwayGtmId": "string",
  • "blackListedPaymentTypes": [
    ],
  • "additionalPaymentTypes": [
    ],
  • "blackListedCountries": [
    ],
  • "restrictedCountries": [
    ],
  • "fallbackCartCountry": "string",
  • "forceGeoipLocalization": true,
  • "promoteOneClickPayment": true,
  • "allowOrderDetailsOnCheckoutConfirmation": true,
  • "allowQuotes": true,
  • "recipientCodeMandatory": true,
  • "allowMultipleDiscounts": true,
  • "retryPaymentValidityDuration": 90,
  • "quoteValidityDuration": 90,
  • "quoteSubscriptionValidityDuration": 90,
  • "multiplePaymentsValidityDuration": 90,
  • "targetNonRecurrentPaymentMethodsForSubscriptions": "NOBODY",
  • "eligibleEndUserTypes": [
    ],
  • "thankYouDesc": {
    },
  • "emailSenderOverride": "string",
  • "localizedPaymentDescriptors": {
    },
  • "externalContextAlias": "string",
  • "externalContextGenerationParams": [
    ],
  • "allowInstallments": true,
  • "installmentOptions": [
    ],
  • "allowSubscriptionUpgrade": true,
  • "route": {
    },
  • "deprecatedHostnames": [
    ]
}