CustomFields

Get Custom Fields by key

get/v1/CustomFields(FieldID={FieldID},OrderID={OrderID})

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/CustomFields(FieldID={FieldID},OrderID={OrderID})
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

FieldIDnumber required

Property in multi-part unique identifier of CustomField

OrderIDnumber nullable required

Property in multi-part unique identifier of CustomField

Query parameters

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved entity

FieldIDnumber
OrderIDnumber nullable
ProfileIDnumber
Valuestring nullable

Example response

{
  "FieldID": 0,
  "OrderID": 0,
  "ProfileID": 0,
  "Value": "string",
  "Order": {
    "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.