All Verbs | /service/GetCustomOptionFieldValues | ||
---|---|---|---|
All Verbs | /service/GetCustomOptionFieldValues/{FieldId} | ||
All Verbs | /service/GetCustomOptionFieldValues/{FieldId}/{Id} | ||
All Verbs | /service/sales/products/options | ||
All Verbs | /service/sales/products/options/{FieldId} | ||
All Verbs | /service/sales/products/{ProductId}/options/{FieldId} | ||
All Verbs | /service/orders/products/options | ||
All Verbs | /service/orders/{OrderNumber}/products/{ProductId}/options/{FieldId} | ||
All Verbs | /service/orders/{OrderNumber}/products/{ProductId}/options/{FieldId}/{Id} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Search | query | string | No | |
FieldId | path | string | No | |
Id | path | string | No | |
ProductId | path | string | No | |
OrderNumber | path | string | No | |
RetailerId | query | string | No | |
Selections | query | Dictionary<string, string> | No | |
SelectedUpcharges | query | IEnumerable<FieldValue> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Name | form | string | No | |
UpchargeType | form | string | No | |
Grouping1Value | form | string | No | |
Grouping2Value | form | string | No | |
Grouping3Value | form | string | No | |
Grouping4Value | form | string | No | |
Grouping5Value | form | string | No | |
OptionFieldValuePriceListId | form | string | No | |
CustomValue | form | bool | No | |
Price | form | double | No | |
PriceListDescription | form | string | No | |
Upcharge | form | double | No | |
UpchargeMultiplier | form | double | No | |
QtyAvailable | form | double? | No | |
DateAvailable | form | DateTime? | No | |
Restrictions | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/GetCustomOptionFieldValues HTTP/1.1
Host: www.bernhardt.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
search: String,
fieldId: String,
id: String,
productId: String,
orderNumber: String,
retailerId: String,
selections:
{
String: String
},
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { id: String, name: String, upchargeType: String, grouping1Value: String, grouping2Value: String, grouping3Value: String, grouping4Value: String, grouping5Value: String, optionFieldValuePriceListId: String, customValue: False, price: 0, priceListDescription: String, upcharge: 0, upchargeMultiplier: 0, qtyAvailable: 0, dateAvailable: 0001-01-01, restrictions: String } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }