CustomFields

Creates or Updates a Custom Field

When to use

  • To apply values to Custom Fields
  • To update values in existing Custom Fields

Example

POST v1/CustomFields
{
	"ProfileID": 123456789, // Required if integration has access to multiple profiles
	"OrderID": 123456,
	"FieldID": 2,
	"Value": "R2958179838-7600900"
}
post/v1/CustomFields

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/CustomFields
  • 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

Request body

FieldIDnumber
OrderIDnumber nullable
ProfileIDnumber
Valuestring nullable

Example request

{
  "FieldID": 0,
  "OrderID": 0,
  "ProfileID": 0,
  "Value": "string"
}

Response

Created entity

FieldIDnumber
OrderIDnumber nullable
ProfileIDnumber
Valuestring nullable

Example response

{
  "FieldID": 0,
  "OrderID": 0,
  "ProfileID": 0,
  "Value": "string"
}

Changes

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