Sign in

v1

latestOpenAPI 3.0.32026-07-23243.8 KB

Get order extra fields

Retreive detailed information about order extra fields.

get/orders/{orderId}/extraFields

Path parameters

orderIdstring required

Unique order identifier. Can be either:

  • Internal numeric order ID (e.g. 492512057)
  • Public order ID (e.g. EBJFT)

Response

Successful response

titlestring

Name visible at the checkout above the extra field.

valuestring

Value for the order extra field.

orderDetailsDisplaySectionstring

Defines where on the order details page the extra field is shown to the store owner.
One of:

  • shipping_info — Order shipping details.
  • billing_info — Order payment details.
  • customer_info — Details about the customer.
  • order_comments — Order comments left by the customer.
orderBystring

Number that defines the extra field position in Ecwid admin.
The smaller the number, the higher the position is. Starts with "0" and iterates by 1.

showInNotificationsboolean

Defines if extra field should be visible in order emails sent to the customer. Disabled by default (false).
The orderDetailsDisplaySection value defines where the extra field will appear.

showInInvoiceboolean

Defines if the extra field should be visible in order tax invoices.

idstring

Unique order extra field ID.

customerInputTypestring

Extra field type.
One of:

  • TEXT - Single-line text input
  • TEXTAREA - Multi-line text input
  • SELECT - Drop-down list (single choice)
  • CHECKBOX - List of checkboxes (multiple choices)
  • TOGGLE_BUTTON_GROUP - Toggle buttons
  • RADIO_BUTTONS - Radio-buttons (single choice)
  • DATETIME - Datetime picker
  • LABEL - Simple text without user-defined inputs