get https://app.ecwid.com/api/v3//orders//extraFields
Get all available information about extra fields saved to an order.
Access scopes
Requires the following access scope: read_orders
Response
A JSON object with the following fields:
Field | Type | Description |
---|---|---|
id | string | Extra field ID |
value | string | Extra field value |
customerInputType | string | Supported values: TEXT , TEXTAREA , SELECT , CHECKBOX , TOGGLE_BUTTON_GROUP , RADIO_BUTTONS , DATETIME , LABEL . More on this in [Types of fields] (add-new-fields-to-checkout#types-of-fields) section |
title | string | Title of an extra field that prompts the user to enter the value |
orderDetailsDisplaySection | string | Defines the order section the extra field values is shown to customer and merchant. Supported values: shipping_info , billing_info , customer_info , order_comments . More on this in Show extra fields in an order section. |
orderBy | string | Extra field position at an order section in Ecwid Control Panel. The smaller the number, the higher the position is. |
showInNotifications | boolean | If not specified the default value is false . Set true to show extra field in order emails. orderDetailsDisplaySection sets the part where the extra field will appear. |
showInInvoice | boolean | true /false if the extra field should be displayed in order invoice or not |
Errors
Error response example:
HTTP/1.1 404 Not Found
Content-Type application/json; charset=utf-8
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP codes
HTTP Status | Description |
---|---|
400 | Request parameters are malformed |
403 | Access token doesn't have read_orders scope |
404 | Order or extra field is not found |
405 | Method not allowed. Can occur when using POST instead of PUT HTTP request method |
415 | Unsupported content-type: expected application/json or text/json |
500 | Cannot retrieve extra fields info because of an error on the server |
Error response body (optional)
Field | Type | Description |
---|---|---|
errorMessage | string | Error message |