Last Updated: February 19, 2016
Fetching a price type by its price type id
The API provides to fetch a price type by its price type id from the backend.
Request
HTTP Method | Resource URI |
---|---|
GET | https://{tenantName}.api.xomni.com/private/catalog/currency/{priceTypeId} |
URI Parameters
Parameter Name | Description | Type | Conditions |
---|---|---|---|
priceTypeId | Id of the price type | Number |
Request Headers
Header Field Name | Description |
---|---|
Accept |
Includes minor version header.
Sample: application/vnd.xomni.api-v4-0, */*
|
Authorization |
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da
|
Response
{ "Id":1, "Description":"USD", "PriceTypeSymbol":"$", "DataBag": "some info about price type" }
Response Body Description
Parameter Name | Description | Type |
---|---|---|
Id | Id of the price type | Number |
Description | Description of the price type | String |
PriceTypeSymbol | Symbol for the price type. E.g. $, €, etc. | String |
DataBag | Random text value bag which will be provided by the client. | String |
Response Headers
Header Field Name | Description |
---|---|
Content-Type |
Content type of the response entity. The value of this header is always application/json.
|
Status Codes
A successful operation returns status code 200 (OK) for GET operations. Possible response status codes are as listed below:
Status Code | Description |
---|---|
404 (Not Found) | Price Type Not Found |