Price (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to manage prices

Price

Get distinct currencies by customerId

Search the currencies by customerId

Authorizations:

Bearer

Responses

Get item

Authorizations:

Bearer

path Parameters

id

required

string

Responses

Response samples

200
401
403
404
500

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",
"productId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"country": "FR",
"currency": "EUR",
"value": 14.99,
"upSell": 10.99,
"crossSell": 12.99,
"vatIncluded": true,
"msrp": 39.99,
"marketingCampaignId": "string",
"archived": true,
"history": [{"event": "CREATED",
"when": "2019-08-24T14:15:22Z",
"previousData": { },
"affectedIds": ["string"
]
}
]
}

Update price

Authorizations:

Bearer

Request Body schema: application/json

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
productId required	string Product identifier
startDate required	string <date-time> Price start date timestamp in milliseconds
endDate required	string <date-time> Price end date timestamp in milliseconds
country	string Country code in ISO 3166-2 format
required	object Currency code in ISO-4217 format
value required	number <double> Regular price, two decimal places format
upSell required	number <double> Upsell price, two decimal places format
crossSell required	number <double> CrossSell price, two decimal places format
vatIncluded required	boolean Tax is included in price
msrp	number <double> Recommended price, two decimal places format
marketingCampaignId	string Marketing campaign Id
archived	boolean Indicator if the price was removed/archived

Responses

Request samples

Payload

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",
"productId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"country": "FR",
"currency": "EUR",
"value": 14.99,
"upSell": 10.99,
"crossSell": 12.99,
"vatIncluded": true,
"msrp": 39.99,
"marketingCampaignId": "string",
"archived": true
}

Response samples

200
401
403
404
500

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",
"productId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"country": "FR",
"currency": "EUR",
"value": 14.99,
"upSell": 10.99,
"crossSell": 12.99,
"vatIncluded": true,
"msrp": 39.99,
"marketingCampaignId": "string",
"archived": true,
"history": [{"event": "CREATED",
"when": "2019-08-24T14:15:22Z",
"previousData": { },
"affectedIds": ["string"
]
}
]
}

Delete price

Deleting prices is allowed only for prices that are scheduled in the future. Prices that have already been effective cannot be deleted in order to keep the history of pricing per product

Authorizations:

Bearer

Responses

Response samples

204
401
403
404
500

Content type

application/json

{ }

Get items

Authorizations:

Bearer

query Parameters

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
target	any Return selected fields only (multiple occurrences allowed for selecting multiple fields)

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"id": "string",
"customerId": "string",
"createDate": "2019-08-24T14:15:22Z",
"updateDate": "2019-08-24T14:15:22Z",
"modelVersion": "string",
"dbVersion": 0,
"lastUpdateReason": "string",
"productId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"country": "FR",
"currency": "EUR",
"value": 14.99,
"upSell": 10.99,
"crossSell": 12.99,
"vatIncluded": true,
"msrp": 39.99,
"marketingCampaignId": "string",
"archived": true,
"history": [{"event": "CREATED",
"when": "2019-08-24T14:15:22Z",
"previousData": { },
"affectedIds": ["string"
]
}
]
}
],
"last": true,
"totalItems": 0,
"totalPages": 0,
"size": 0,
"number": 0
}

Create price

Authorizations:

Bearer

Request Body schema: application/json

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
productId required	string Product identifier
startDate required	string <date-time> Price start date timestamp in milliseconds
endDate required	string <date-time> Price end date timestamp in milliseconds
country	string Country code in ISO 3166-2 format
required	object Currency code in ISO-4217 format
value required	number <double> Regular price, two decimal places format
upSell required	number <double> Upsell price, two decimal places format
crossSell required	number <double> CrossSell price, two decimal places format
vatIncluded required	boolean Tax is included in price
msrp	number <double> Recommended price, two decimal places format
marketingCampaignId	string Marketing campaign Id
archived	boolean Indicator if the price was removed/archived

Responses

Request samples

Payload

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",
"productId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"country": "FR",
"currency": "EUR",
"value": 14.99,
"upSell": 10.99,
"crossSell": 12.99,
"vatIncluded": true,
"msrp": 39.99,
"marketingCampaignId": "string",
"archived": true
}

Response samples

201
401
403
404
500

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",
"productId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"country": "FR",
"currency": "EUR",
"value": 14.99,
"upSell": 10.99,
"crossSell": 12.99,
"vatIncluded": true,
"msrp": 39.99,
"marketingCampaignId": "string",
"archived": true,
"history": [{"event": "CREATED",
"when": "2019-08-24T14:15:22Z",
"previousData": { },
"affectedIds": ["string"
]
}
]
}

Get best price for parameters

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

Authorizations:

Bearer

query Parameters

customerId required	any ID of the customer
productId required	any ID of the product
country required	any Example: country=FR Country code in ISO 3166-2 format
currency	any Example: currency=USD Currency code in ISO-4217 format
defaultCurrency	any Example: defaultCurrency=EUR Fallback currency code in ISO-4217 format
date	any Effective date in ISO-8601 format, examples: 2020-10-14, 2020-10-14T12:00:00Z
marketingCampaignId	any ID of marketing campaign

Responses

Get distinct values for a given field

Authorizations:

Bearer

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{ }
],
"last": true,
"totalItems": 0,
"totalPages": 0,
"size": 0,
"number": 0
}

Get recap quantities for a given field

Authorizations:

Bearer

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"targetValue": "string",
"count": 0
}
],
"last": true,
"totalItems": 0,
"totalPages": 0,
"size": 0,
"number": 0
}

Search unwind for a given field

Authorizations:

Bearer

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"items": [{"empty": true,
"property1": { },
"property2": { }
}
],
"last": true,
"totalItems": 0,
"totalPages": 0,
"size": 0,
"number": 0
}

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