put https://app.ecwid.com/api/v3//orders//extraFields/
This request allows you to update existing extra fields saved in orders in an Ecwid store. When updating an extra field, you can omit unchanged fields – they will be ignored so the resulting extra field will keep the corresponding information unchanged.
Access scopes required: read_orders and update_orders
Headers
| Name | Type | Description |
|---|---|---|
| Authorization | string | oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token. |
Request
A JSON object of type 'orderExtraFields' with the following fields:
orderExtraFields
| Field | Type | Description |
|---|---|---|
| value | string | Extra field's value |
| 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. Use it to sort fields within the same orderDetailsDisplaySection. 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 |
Response
A JSON object of type 'UpdateStatus' with the following fields:
UpdateStatus
| Field | Type | Description |
|---|---|---|
| updateCount | number | The number of updated extra fields (1 or 0 depending on whether the update was successful) |
Errors
Error response example:
HTTP/1.1 404 ExtraField #wrapping_box 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 invalid |
| 403 | Access token doesn't have update_orders scope |
| 404 | Order or extra field is not found |
| 415 | Unsupported content-type: expected application/json or text/json |
| 500 | Cannot update the order info because of an error on the server |
Error response body (optional)
| Field | Type | Description |
|---|---|---|
| errorMessage | string | Error message |