Skip to main content
API docs by Redocly

Price (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to manage prices

Price

Get items

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Return selected fields only (multiple occurrences allowed for selecting multiple fields)

customerId
any

Filter prices by customerId

productId
any

Filter prices by productId

country
any

Filter prices by country

currency
any

Filter prices by currency

value
any

Filter prices by price

upSell
any

Filter prices by upSell price

crossSell
any

Filter prices by crossSell price

msrp
any

Filter prices by msrp value

vatIncluded
any

Filter prices with or without vat included

startingDate
any

Filter by start date of the price. You can use date ranges by using < or << operator, examples: startingDate=XXXX< will return prices starting after XXXX, startingDate=<XXXX will return prices starting before XXXX, startingDate=XXXX<<YYYYY will return prices starting between XXXX and YYYY

endingDate
any

Filter by end date of the price. You can use date ranges by using < or << operator, examples: endingDate=XXXX< will return prices ending after XXXX, endingDate=<XXXX will return prices ending before XXXX, endingDate=XXXX<<YYYYY will return prices ending between XXXX and YYYY

marketingCampaignId
any

Filter prices by marketingCampaignId

Responses

Response samples

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

Create an item

Authorizations:
Bearer
Request Body schema: application/json
required
archived
boolean

Indicator if the price was removed/archived

country
string

Country code in ISO 3166-2 format

createDate
string <date-time>
Deprecated
crossSell
required
number <double>

CrossSell price, two decimal places format

required
object

Currency code in ISO-4217 format

customerId
string
dbVersion
integer <int64>
endDate
required
string <date-time>

Price end date timestamp in milliseconds

externalContext
string
id
string
Deprecated
idUpdateTask
string
lastUpdateReason
string
mandateValue
number <double>

Mandate value

marketingCampaignId
string

Marketing campaign Id

modelVersion
string
Deprecated
msrp
number <double>

Recommended price, two decimal places format

originalId
string
productId
required
string

Product identifier

object (RemotePrice)

Remote price information

source
string
Enum: "INTERNAL" "EXTERNAL" "INTERNAL_CONVERTED" "MANDATE_VALUE"

Source of the price

startDate
required
string <date-time>

Price start date timestamp in milliseconds

upSell
required
number <double>

Upsell price, two decimal places format

updateDate
string <date-time>
Deprecated
value
required
number <double>

Regular price, two decimal places format

vatIncluded
required
boolean

Tax is included in price

Responses

Request samples

Content type
application/json
{
  • "archived": true,
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "crossSell": 12.99,
  • "currency": "EUR",
  • "customerId": "string",
  • "dbVersion": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "externalContext": "string",
  • "id": "string",
  • "idUpdateTask": "string",
  • "lastUpdateReason": "string",
  • "mandateValue": 0.1,
  • "marketingCampaignId": "string",
  • "modelVersion": "string",
  • "msrp": 39.99,
  • "originalId": "string",
  • "productId": "string",
  • "remotePrice": {
    },
  • "source": "INTERNAL",
  • "startDate": "2019-08-24T14:15:22Z",
  • "upSell": 10.99,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "value": 14.99,
  • "vatIncluded": true
}

Response samples

Content type
application/json
{
  • "archived": true,
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "crossSell": 12.99,
  • "currency": "EUR",
  • "customerId": "string",
  • "dbVersion": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "externalContext": "string",
  • "history": [
    ],
  • "id": "string",
  • "lastUpdateReason": "string",
  • "mandateValue": 0.1,
  • "marketingCampaignId": "string",
  • "modelVersion": "string",
  • "msrp": 39.99,
  • "productId": "string",
  • "remotePrice": {
    },
  • "source": "INTERNAL",
  • "startDate": "2019-08-24T14:15:22Z",
  • "upSell": 10.99,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "value": 14.99,
  • "vatIncluded": true
}

Get best price for parameters

Search price for product with given parameters: country, currency, defaultCurrency, effective date

Authorizations:
Bearer
query Parameters
productId
required
string

ID of the product

country
required
string
Example: country=FR

Country code in ISO 3166-2 format

customerId
required
string

ID of the customer

currency
string
Example: currency=USD

Currency code in ISO-4217 format

defaultCurrency
string
Example: defaultCurrency=EUR

Fallback currency code in ISO-4217 format

initialCurrency
string
date
string <date-time>
Default: "2025-05-29T13:11:04.276Z"

Effective date in ISO-8601 format, examples: 2020-10-14, 2020-10-14T12:00:00Z

marketingCampaignId
string

ID of marketing campaign

isRemotePrice
boolean
useCurrencyConversion
boolean

Responses

create multiple prices

Create multiple prices for import export service

Authorizations:
Bearer
Request Body schema: application/json
required
Array of objects (Price)
Array
archived
boolean

Indicator if the price was removed/archived

country
string

Country code in ISO 3166-2 format

createDate
string <date-time>
Deprecated
crossSell
required
number <double>

CrossSell price, two decimal places format

required
object

Currency code in ISO-4217 format

customerId
string
dbVersion
integer <int64>
endDate
required
string <date-time>

Price end date timestamp in milliseconds

externalContext
string
id
string
Deprecated
idUpdateTask
string
lastUpdateReason
string
mandateValue
number <double>

Mandate value

marketingCampaignId
string

Marketing campaign Id

modelVersion
string
Deprecated
msrp
number <double>

Recommended price, two decimal places format

originalId
string
productId
required
string

Product identifier

object (RemotePrice)

Remote price information

source
string
Enum: "INTERNAL" "EXTERNAL" "INTERNAL_CONVERTED" "MANDATE_VALUE"

Source of the price

startDate
required
string <date-time>

Price start date timestamp in milliseconds

upSell
required
number <double>

Upsell price, two decimal places format

updateDate
string <date-time>
Deprecated
value
required
number <double>

Regular price, two decimal places format

vatIncluded
required
boolean

Tax is included in price

Responses

Request samples

Content type
application/json
{
  • "prices": [
    ]
}

Get distinct currencies by customerId

Search the currencies by customerId

Authorizations:
Bearer
path Parameters
customerId
required
string
query Parameters
version
string

Responses

Get distinct values for a given field

Authorizations:
Bearer
query Parameters
target
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

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

Get a list of product ids with available marketing campaign prices

This endpoint is used in order to get a list of product ids that have an available marketing campaign. It is currently used by marketing-campaign service

Authorizations:
Bearer
path Parameters
id
required
string

marketing campaign's id

Request Body schema: application/json
required
country
string
object
customerId
required
string
date
required
string <date-time>
productIdsList
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "country": "string",
  • "currency": {
    },
  • "customerId": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "productIdsList": [
    ]
}

Response samples

Content type
application/json
"string"

Update prices of marketing campaign

Create multiple prices for import export service

Authorizations:
Bearer
path Parameters
marketingCampaigneId
required
string
endDate
required
integer <int64>

Responses

Get recap quantities for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

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

Search unwind for a given field

Authorizations:
Bearer
query Parameters
target
required
string
required
object (Pageable)
predicate
required
object

Responses

Response samples

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

Delete item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Get item

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "archived": true,
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "crossSell": 12.99,
  • "currency": "EUR",
  • "customerId": "string",
  • "dbVersion": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "externalContext": "string",
  • "history": [
    ],
  • "id": "string",
  • "lastUpdateReason": "string",
  • "mandateValue": 0.1,
  • "marketingCampaignId": "string",
  • "modelVersion": "string",
  • "msrp": 39.99,
  • "productId": "string",
  • "remotePrice": {
    },
  • "source": "INTERNAL",
  • "startDate": "2019-08-24T14:15:22Z",
  • "upSell": 10.99,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "value": 14.99,
  • "vatIncluded": true
}

Update item

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
archived
boolean

Indicator if the price was removed/archived

country
string

Country code in ISO 3166-2 format

createDate
string <date-time>
Deprecated
crossSell
required
number <double>

CrossSell price, two decimal places format

required
object

Currency code in ISO-4217 format

customerId
string
dbVersion
integer <int64>
endDate
required
string <date-time>

Price end date timestamp in milliseconds

externalContext
string
id
string
Deprecated
idUpdateTask
string
lastUpdateReason
string
mandateValue
number <double>

Mandate value

marketingCampaignId
string

Marketing campaign Id

modelVersion
string
Deprecated
msrp
number <double>

Recommended price, two decimal places format

originalId
string
productId
required
string

Product identifier

object (RemotePrice)

Remote price information

source
string
Enum: "INTERNAL" "EXTERNAL" "INTERNAL_CONVERTED" "MANDATE_VALUE"

Source of the price

startDate
required
string <date-time>

Price start date timestamp in milliseconds

upSell
required
number <double>

Upsell price, two decimal places format

updateDate
string <date-time>
Deprecated
value
required
number <double>

Regular price, two decimal places format

vatIncluded
required
boolean

Tax is included in price

Responses

Request samples

Content type
application/json
{
  • "archived": true,
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "crossSell": 12.99,
  • "currency": "EUR",
  • "customerId": "string",
  • "dbVersion": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "externalContext": "string",
  • "id": "string",
  • "idUpdateTask": "string",
  • "lastUpdateReason": "string",
  • "mandateValue": 0.1,
  • "marketingCampaignId": "string",
  • "modelVersion": "string",
  • "msrp": 39.99,
  • "originalId": "string",
  • "productId": "string",
  • "remotePrice": {
    },
  • "source": "INTERNAL",
  • "startDate": "2019-08-24T14:15:22Z",
  • "upSell": 10.99,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "value": 14.99,
  • "vatIncluded": true
}

Response samples

Content type
application/json
{
  • "archived": true,
  • "country": "FR",
  • "createDate": "2019-08-24T14:15:22Z",
  • "crossSell": 12.99,
  • "currency": "EUR",
  • "customerId": "string",
  • "dbVersion": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "externalContext": "string",
  • "history": [
    ],
  • "id": "string",
  • "lastUpdateReason": "string",
  • "mandateValue": 0.1,
  • "marketingCampaignId": "string",
  • "modelVersion": "string",
  • "msrp": 39.99,
  • "productId": "string",
  • "remotePrice": {
    },
  • "source": "INTERNAL",
  • "startDate": "2019-08-24T14:15:22Z",
  • "upSell": 10.99,
  • "updateDate": "2019-08-24T14:15:22Z",
  • "value": 14.99,
  • "vatIncluded": true
}

Public

Get available currencies

Search the available currencies based on a set of product IDs and a marketingCampaign id

Authorizations:
Bearer
query Parameters
productId
required
any

One or multiple productIds separated by comma

marketingCampaignId
any

ID of marketing campaign

Request Body schema: application/json
required
Array of objects (ProductInput)
Array
id
required
string
marketingCampaignId
string

Responses

Request samples

Content type
application/json
{
  • "productInputs": [
    ]
}