Response [200 Ok]
| Uri | /api/v2/pricelist/KHJSz?_responseLevel=Default |
|---|---|
| UriDescription | Pricelist by PricelistKey |
| EndpointType | PricelistKey |
| Locator | PricelistKey |
| LocatorType | Object |
PricelistKey [1 of 1]
/api/v2/pricelist/KHJSz
| Uri | /api/v2/pricelist/KHJSz |
|---|---|
| UriDescription | Pricelist by PricelistKey |
| ResponseLevel | Public |
| CardEnabled | false |
| Currency | USD |
| FoldedCardEnabled | false |
| LastModified | 2023-06-23T18:04:54+00:00 |
Uris
PricelistSkuPrices
/api/v2/pricelist/KHJSz!prices
| Uri | /api/v2/pricelist/KHJSz!prices |
|---|---|
| UriDescription | Priced Skus |
| EndpointType | PricelistSkuPrices |
| Locator | PricelistSkuPrice |
| LocatorType | Objects |
Request
| Uri | /api/v2/pricelist/KHJSz?_responseLevel=Default |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
Output Fields
| AddonsAllowed | boolean | Whether addons are allowed. |
|---|---|---|
| CardEnabled | boolean | Whether cards are enabled. |
| CardMarkupPercent | integer | Profit percentage of base card price. |
| ColorCorrection | boolean | |
| Currency | text | Three-character currency code |
| DateCreated | datetimeiso8601 | |
| Default | boolean | Whether this is the default pricelist, assigned to the user's root node. |
| Description | text | |
| FoldedCardEnabled | boolean | Whether albums are enabled. |
| FoldedCardMarkupPercent | integer | Profit percentage of base folded card price. |
| LastModified | datetimeiso8601 | |
| Name | text | |
| PricelistKey | text | Pricelist key |
| PrintVendor | text | Print lab used |
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/pricelist/KHJSz?_responseLevel=Default"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
}
},
"Methods": [
"OPTIONS",
"GET"
],
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Output": [
{
"Name": "PricelistKey",
"Description": "Pricelist key",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "AddonsAllowed",
"Description": "Whether addons are allowed.",
"Type": "Boolean"
},
{
"Name": "CardEnabled",
"Description": "Whether cards are enabled.",
"Type": "Boolean"
},
{
"Name": "CardMarkupPercent",
"Description": "Profit percentage of base card price.",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "FoldedCardEnabled",
"Description": "Whether albums are enabled.",
"Type": "Boolean"
},
{
"Name": "FoldedCardMarkupPercent",
"Description": "Profit percentage of base folded card price.",
"Type": "Integer",
"MIN_VALUE": "NEGATIVE_INFINITY",
"MAX_VALUE": "POSITIVE_INFINITY"
},
{
"Name": "Currency",
"Description": "Three-character currency code",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "ColorCorrection",
"Type": "Boolean"
},
{
"Name": "DateCreated",
"Type": "DateTimeISO8601"
},
{
"Name": "Default",
"Description": "Whether this is the default pricelist, assigned to the user's root node.",
"Type": "Boolean"
},
{
"Name": "Description",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "LastModified",
"Type": "DateTimeISO8601"
},
{
"Name": "Name",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
},
{
"Name": "PrintVendor",
"Description": "Print lab used",
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": "INFINITY"
}
],
"ResponseLevels": [
"Full",
"Public"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "pricelist"
},
{
"type": "singleparam",
"param_name": "pricelistkey",
"param_value": "KHJSz",
"param_validator": {}
}
]
},
"Response": {
"Uri": "/api/v2/pricelist/KHJSz?_responseLevel=Default",
"Locator": "PricelistKey",
"LocatorType": "Object",
"PricelistKey": {
"CardEnabled": false,
"FoldedCardEnabled": false,
"Currency": "USD",
"LastModified": "2023-06-23T18:04:54+00:00",
"Uri": "/api/v2/pricelist/KHJSz",
"UriDescription": "Pricelist by PricelistKey",
"Uris": {
"PricelistSkuPrices": {
"Uri": "/api/v2/pricelist/KHJSz!prices",
"Locator": "PricelistSkuPrice",
"LocatorType": "Objects",
"UriDescription": "Priced Skus",
"EndpointType": "PricelistSkuPrices"
}
},
"ResponseLevel": "Public"
},
"UriDescription": "Pricelist by PricelistKey",
"EndpointType": "PricelistKey",
"Timing": {
"Total": {
"time": 0.02448,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}