For AI agents: markdown of this page — /docs-content-en/entities/shipments/fields.md documentation index — /llms.txt

Fields: Shipments

GET /v1/shipments/fields

Scope: sale.

Example

Terminal

curl -X GET 'https://vibecode.bitrix24.com/v1/shipments/fields' -H 'X-Api-Key: YOUR_KEY'

Behavior

Check fields and supported operations in /v1/guide.

Response

JSON

{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true
      },
      "trackingNumber": {
        "type": "string",
        "readonly": false
      }
    }
  }
}

Errors

HTTP	Code
400	INVALID_PARAMS / READONLY_FIELD / MISSING_REQUIRED_FIELDS / UNKNOWN_FILTER_FIELD
401	TOKEN_MISSING
403	SCOPE_DENIED / WRITE_BLOCKED_READONLY_KEY / ACCESS_DENIED
404	ENTITY_NOT_FOUND
422	BITRIX_ERROR / BITRIX_NO_EFFECT
429	QUEUE_OVERFLOW / ERROR_LOOP_DETECTED
502	BITRIX_UNAVAILABLE
503	BITRIX_TIMEOUT

Shipments