Get Order Fields sale.order.getfields
Scope:
saleWho can execute the method: administrator
The method sale.order.getfields retrieves the available fields of an order.
No parameters.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.getfields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.order.getfields
try
{
const response = await $b24.callMethod(
"sale.order.getfields", {}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'sale.order.getfields',
[]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Fields: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting order fields: ' . $e->getMessage();
}
BX24.callMethod(
"sale.order.getfields", {},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'sale.order.getfields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"order": {
"accountNumber": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "string"
},
"additionalInfo": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"affiliateId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"canceled": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"comments": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"companyId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"currency": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "string"
},
"dateCanceled": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateInsert": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "datetime"
},
"dateLock": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateMarked": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateStatus": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"dateUpdate": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "datetime"
},
"deducted": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "char"
},
"discountValue": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "double"
},
"empCanceledId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"empMarkedId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"empStatusId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"externalOrder": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"id": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "integer"
},
"id1c": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"lid": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "string"
},
"lockedBy": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"marked": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"orderTopic": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"payed": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "char"
},
"personTypeId": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"type": "integer"
},
"personTypeXmlId": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "string"
},
"price": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "double"
},
"reasonCanceled": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"reasonMarked": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"recountFlag": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"recurringId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"responsibleId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"statusId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"statusXmlId": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "string"
},
"taxValue": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "double"
},
"updated1c": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "char"
},
"userDescription": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"userId": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": false,
"type": "integer"
},
"version": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"type": "integer"
},
"version1c": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
},
"xmlId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"type": "string"
}
}
},
"time": {
"start": 1712825736.172681,
"finish": 1712825736.838046,
"duration": 0.6653649806976318,
"processing": 0.03579592704772949,
"date_start": "2024-04-11T11:55:36+02:00",
"date_finish": "2024-04-11T11:55:36+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
order |
Object in the format |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":0,
"error_description":"error"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to read available order fields |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Order sale.order.add
- Update Order sale.order.update
- Get Order Field Values and Related Objects sale.order.get
- Get the list of orders sale.order.list
- Delete Order and Related Objects sale.order.delete