sale.shipment.getFields — метод REST API Битрикс24

Описание

Метод sale.shipment.getFields получает доступные поля отгрузки.

Примеры запроса

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.shipment.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.shipment.getFields

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FieldDescription = {
  isImmutable: boolean
  isReadOnly: boolean
  isRequired: boolean
  type: string
}

// Shape of the payload returned in result (match the "response handling" section of the page)
type ShipmentGetFieldsResult = {
  shipment: Record<string, FieldDescription>
}

try {
  const response = await $b24.actions.v2.call.make<ShipmentGetFieldsResult>({
    method: 'sale.shipment.getFields',
    params: {},
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(Object.keys(result.shipment), result.shipment)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function getShipmentFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.shipment.getFields',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(Object.keys(result.shipment), result.shipment)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getShipmentFields)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.sale.shipment.getfields().response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'sale.shipment.getFields',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Data: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error getting shipment fields: ' . $e->getMessage();
}

BX24.callMethod(
    "sale.shipment.getFields", {},
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'sale.shipment.getFields',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.shipment.getFields", nil, b24.WithIdempotent())
if err != nil {
    return fmt.Errorf("sale.shipment.getFields: %w", err)
}

// Метод заворачивает ответ в объект с ключом "shipment".
raw, ok := b24.Unwrap(res.Result, "shipment")
if !ok {
	return fmt.Errorf("в ответе нет ключа shipment")
}

fmt.Printf("%s\n", raw)

Ответ

HTTP-статус: 200

{
   "result":{
      "shipment":{
         "accountNumber":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "allowDelivery":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":true,
            "type":"char"
         },
         "basePriceDelivery":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"double"
         },
         "canceled":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"char"
         },
         "comments":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         },
         "companyId":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"integer"
         },
         "currency":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "customPriceDelivery":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"char"
         },
         "dateAllowDelivery":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"datetime"
         },
         "dateCanceled":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"datetime"
         },
         "dateDeducted":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"datetime"
         },
         "dateInsert":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"datetime"
         },
         "dateMarked":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"datetime"
         },
         "dateResponsibleId":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"datetime"
         },
         "deducted":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":true,
            "type":"char"
         },
         "deliveryDocDate":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"datetime"
         },
         "deliveryDocNum":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         },
         "deliveryId":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":true,
            "type":"integer"
         },
         "deliveryName":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "deliveryXmlId":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "discountPrice":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"double"
         },
         "empAllowDeliveryId":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"integer"
         },
         "empCanceledId":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"integer"
         },
         "empDeductedId":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"integer"
         },
         "empMarkedId":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"integer"
         },
         "empResponsibleId":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"integer"
         },
         "externalDelivery":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"char"
         },
         "id":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"integer"
         },
         "id1c":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "marked":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"char"
         },
         "orderId":{
            "isImmutable":true,
            "isReadOnly":false,
            "isRequired":true,
            "type":"integer"
         },
         "priceDelivery":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"double"
         },
         "reasonMarked":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "reasonUndoDeducted":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "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":"char"
         },
         "system":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"char"
         },
         "trackingDescription":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "trackingLastCheck":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "trackingNumber":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         },
         "trackingStatus":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "updated1c":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"char"
         },
         "version1c":{
            "isImmutable":false,
            "isReadOnly":true,
            "isRequired":false,
            "type":"string"
         },
         "xmlId":{
            "isImmutable":false,
            "isReadOnly":false,
            "isRequired":false,
            "type":"string"
         }
      }
   },
   "time":{
      "start":1713190893.141474,
      "finish":1713190895.854316,
      "duration":2.7128419876098633,
      "processing":0.16173791885375977,
      "date_start":"2024-04-15T17:21:33+03:00",
      "date_finish":"2024-04-15T17:21:35+03:00"
   }
}

Возвращаемые данные

result object

Корневой элемент ответа

shipment object

Объект в формате {"field_1": "value_1", ... "field_N": "value_N"}, где field — идентификатор поля объекта sale_order_shipment , а value — объект типа rest_field_description

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
   "error":0,
   "error_description":"error"
}

Код	Описание	Значение
`200040300010`	Недостаточно прав для чтения доступных полей отгрузки
`0`	Другие ошибки (например, фатальные ошибки)