8.3. Get the result of applying changes

  1. HTTP Request
  2. Query Parameters
  3. Header Parameters
  4. Responses
    1. Code 200
      1. Representation
      2. Fields
    2. Code 404
      1. Representation
      2. Fields
  5. Example

Get the result of applying changes

HTTP Request

POST b2b.taxi.yandex.net/b2b/cargo/integration/v2/claims/apply-changes/result\
?claim_id={string}\
&request_id={string}

Query Parameters

claim_id *

string

Claim ID, received upon creation of claim

request_id *

string

Unique change request ID (idempotency token)

claim_id *

string

Claim ID, received upon creation of claim

request_id *

string

Unique change request ID (idempotency token)

Header Parameters

Accept-Language *

string

Preferred language of response. Examples: "ru" — Russian, "en" — English

Accept-Language *

string

Preferred language of response. Examples: "ru" — Russian, "en" — English

Responses

Code 200

OK

{
  "changes": [
    {
      "error": {
        "code": string,
        "message": string
      },
      "id": integer,
      "kind": string,
      "status": string
    }
  ]
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

changes[] *

array

changes[].error

object

Error information

changes[].error.code *

string

String error code

Allowed values
  1. address_not_found
  2. address_outside_delivery_zone
  3. address_too_far
  4. apply_change_error
  5. bad_request
  6. cancel_error
  7. cargo_payments_update_error
  8. change_destination_error
  9. claim_is_outdated
  10. claim_not_ready
  11. claim_point_not_ready
  12. confirmation_code_required
  13. cost_mismatch
  14. country_phone_code_not_supported
  15. currency_mismatch
  16. custom_context_in_bad_format
  17. db_error
  18. delay_too_long
  19. double_request
  20. due_in_past
  21. duplicate_id
  22. duplicate_source_point
  23. esignature_error
  24. esignature_too_many_requests
  25. external_order_id_not_allowed
  26. free_cancel_is_unavailable
  27. inappropriate_point
  28. inappropriate_status
  29. invalid_cursor
  30. invalid_delivery_interval
  31. invalid_destination_point
  32. invalid_destination_point_phone
  33. invalid_emergency_contact_phone
  34. invalid_fiscalization_status
  35. invalid_item_destination_point
  36. invalid_item_source_point
  37. invalid_payment_mode
  38. invalid_payment_subject
  39. invalid_phone_incorrect_symbol
  40. invalid_phone_must_start_plus_symbol
  41. invalid_phone_size_incorrect
  42. invalid_point_phone
  43. invalid_post_payment
  44. invalid_return_point_phone
  45. invalid_source_point
  46. invalid_source_point_phone
  47. invalid_time_intervals
  48. item_destination_point_not_found
  49. item_has_no_fiscalization
  50. item_source_point_not_found
  51. items_without_parameters_forbidden
  52. max_apply_changes
  53. no_input_point
  54. no_performer_info
  55. no_required_email_for_point
  56. not_allowed
  57. not_found
  58. offer_expired
  59. old_lookup_version
  60. old_version
  61. order_creation_conflict
  62. parse_error
  63. payment_and_skip_sms_conflict
  64. payment_on_delivery_disabled
  65. payment_on_delivery_invalid_request
  66. payment_on_delivery_invalid_token
  67. payment_required
  68. payment_sms_send_failed
  69. payment_terminal_error
  70. pdf_failure
  71. point_not_found
  72. sdd_items_without_parameters_forbidden
  73. sdd_client_requirements_forbidden
  74. sdd_multipoints_not_supported
  75. send_email_error
  76. solver_failed
  77. source_point_missing
  78. state_mismatch
  79. state_transition_forbidden
  80. tariff_error
  81. task_not_found
  82. too_few_points
  83. too_much_claim_edits
  84. unknown_performer_position
  85. unknown_zone
  86. unsupported_points_count
  87. use_waybills_admin_page
  88. validation_error
  89. wrong_corp_client_id
  90. wrong_pickup_code_format
  91. wrong_pickup_code_usage
  92. wrong_taxi_order_id
  93. too_many_requests
  94. create_throttled
  95. terminal_status
  96. forbidden_by_antifake

changes[].error.message *

string

Human-readable error message

changes[].id *

integer

Unique change ID (int64)

changes[].kind *

string

Change type

changes[].status *

string

Change processing status

Allowed values
  1. new
  2. pending
  3. applied
  4. failed

changes[] *

array

changes[].error

object

Error information

changes[].error.code *

string

String error code

Allowed values
  1. address_not_found
  2. address_outside_delivery_zone
  3. address_too_far
  4. apply_change_error
  5. bad_request
  6. cancel_error
  7. cargo_payments_update_error
  8. change_destination_error
  9. claim_is_outdated
  10. claim_not_ready
  11. claim_point_not_ready
  12. confirmation_code_required
  13. cost_mismatch
  14. country_phone_code_not_supported
  15. currency_mismatch
  16. custom_context_in_bad_format
  17. db_error
  18. delay_too_long
  19. double_request
  20. due_in_past
  21. duplicate_id
  22. duplicate_source_point
  23. esignature_error
  24. esignature_too_many_requests
  25. external_order_id_not_allowed
  26. free_cancel_is_unavailable
  27. inappropriate_point
  28. inappropriate_status
  29. invalid_cursor
  30. invalid_delivery_interval
  31. invalid_destination_point
  32. invalid_destination_point_phone
  33. invalid_emergency_contact_phone
  34. invalid_fiscalization_status
  35. invalid_item_destination_point
  36. invalid_item_source_point
  37. invalid_payment_mode
  38. invalid_payment_subject
  39. invalid_phone_incorrect_symbol
  40. invalid_phone_must_start_plus_symbol
  41. invalid_phone_size_incorrect
  42. invalid_point_phone
  43. invalid_post_payment
  44. invalid_return_point_phone
  45. invalid_source_point
  46. invalid_source_point_phone
  47. invalid_time_intervals
  48. item_destination_point_not_found
  49. item_has_no_fiscalization
  50. item_source_point_not_found
  51. items_without_parameters_forbidden
  52. max_apply_changes
  53. no_input_point
  54. no_performer_info
  55. no_required_email_for_point
  56. not_allowed
  57. not_found
  58. offer_expired
  59. old_lookup_version
  60. old_version
  61. order_creation_conflict
  62. parse_error
  63. payment_and_skip_sms_conflict
  64. payment_on_delivery_disabled
  65. payment_on_delivery_invalid_request
  66. payment_on_delivery_invalid_token
  67. payment_required
  68. payment_sms_send_failed
  69. payment_terminal_error
  70. pdf_failure
  71. point_not_found
  72. sdd_items_without_parameters_forbidden
  73. sdd_client_requirements_forbidden
  74. sdd_multipoints_not_supported
  75. send_email_error
  76. solver_failed
  77. source_point_missing
  78. state_mismatch
  79. state_transition_forbidden
  80. tariff_error
  81. task_not_found
  82. too_few_points
  83. too_much_claim_edits
  84. unknown_performer_position
  85. unknown_zone
  86. unsupported_points_count
  87. use_waybills_admin_page
  88. validation_error
  89. wrong_corp_client_id
  90. wrong_pickup_code_format
  91. wrong_pickup_code_usage
  92. wrong_taxi_order_id
  93. too_many_requests
  94. create_throttled
  95. terminal_status
  96. forbidden_by_antifake

changes[].error.message *

string

Human-readable error message

changes[].id *

integer

Unique change ID (int64)

changes[].kind *

string

Change type

changes[].status *

string

Change processing status

Allowed values
  1. new
  2. pending
  3. applied
  4. failed

Code 404

Change not found

{
  "code": string,
  "message": string
}
Copied to clipboard

Representation

Collapse all
Expand all

Fields

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

code *

string

String error code

Allowed values
  1. not_found

message *

string

Human-readable error message

Example

Responses:

{
  "changes": [
    {
      "error": {
        "code": "state_mismatch",
        "message": "State mismatch error"
      }
    }
  ]
}
Copied to clipboard