Order Custom Fields

Status: Trusted Tester

Custom fields associated with a sales order. The field definitions can be managed at Partner Center -> Administration -> Custom Fields.

One form of identifier should be chosen, either fieldId or externalId. fieldId is the computer generated ID (like FieldID-abc448ca-abc0-abc5-abc2-abc640bf4b99) and externalId is a optional human-readable ID that can be set in the administration panel.

Dropdown possible value and the currency code are also configured in the Administration panel.

idstringrequired

An identifier for the parent entity, for example order (AG-1231231:ORD-12345671)

Example: AG-1231231:ORD-1234567

typestringrequired

Should always be orderCustomFields

Possible values: [orderCustomFields]

Default value: orderCustomFields

attributes object

partnerFields object[]

List of custom fields specific to the partner with a direct relationship to the sales order. To send a new value each field must have at least the fieldId and its correspondent value. For example a field of type string must have the stringValue attribute filled.

string -> stringValue

integer -> integerValue

date -> dateValue

Only the fields that you wish to modify need to be sent.

Array [

fieldIdstring

Field identifier, can be retrieved by listing the attributes

externalIdstring

Alternative field identifier, can be set on admin panel and can be retrieved by listing the attributes

fieldTypestring

Indicates which of the value fields to use to read or write the data. It can only be modified from within partner center.

string -> stringValue

integer -> integerValue

date -> dateValue

dropdown -> dropdownValue

currency -> currencyValue

Possible values: [string, integer, date, dropdown, currency]

Example: string

stringValuestring

Required when the field type is string

integerValueinteger

Required when the field type is integer

dateValuedate

Required when the field type is date

dropdownValuestring

Required when type is dropdown. The possible values can be discovered using the administration panel.

currencyValueinteger

Required when the field type is currency.

This field represents the cents (or the smallest part of the currency).

Example: USD 600.00 -> currencyValue=60000

currencyCodestring

Represents the type of currency when the field is type currency. It will be the 3 letter currency code as defined by ISO 4217

Ex: USD, CAD, AUD

Possible values: >= 3 characters and <= 3 characters

Example: USD

titlestring

The main label for the field, appearing in most user interfaces that show the value. This field is not read when setting a value.

descriptionstring

A longer text explanation of the field, it optionally appears in the UI. This field is not read when setting a value.

]

Order Custom Fields

{
  "id": "AG-1231231:ORD-1234567",
  "type": "orderCustomFields",
  "attributes": {
    "partnerFields": [
      {
        "fieldId": "string",
        "externalId": "string",
        "fieldType": "string",
        "stringValue": "string",
        "integerValue": 0,
        "dateValue": "2024-07-29",
        "dropdownValue": "string",
        "currencyValue": 0,
        "currencyCode": "USD",
        "title": "string",
        "description": "string"
      }
    ]
  }
}