Validate draft

GET

/shipping/orders/validate_draft/v1/:order_id

GET

/shipping/orders/validate_draft/v1/:order_id

1 import { ChrtClient } from "@chrt-inc/typescript-sdk";
2 
3 async function main() {
4     const client = new ChrtClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.shipping.orders.validateDraftV1("order_id");
8 }
9 main();

1 {
2   "is_valid": true,
3   "requirements": {
4     "all_entities_are_draft": true,
5     "at_least_one_task_has_time_window": true,
6     "cargos_have_valid_lifecycle": true,
7     "coordinator_shipper_accounts_match_order": true,
8     "order_has_coordinator": true,
9     "order_has_shipper": true,
10     "order_has_task_groups": true,
11     "task_groups_have_valid_task_sequence": true,
12     "task_groups_have_valid_tasks": true,
13     "tasks_have_valid_actions": true,
14     "tasks_have_valid_cargo": true
15   },
16   "issues": [
17     {
18       "requirement_key": "requirement_key"
19     }
20   ]
21 }

Validates a draft order for staging and returns requirement results. | authz_personas=[draft_creator_org_operator] | () -> (OrderDraftValidationResult)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

order_idstringRequired

Response

Successful Response

is_validboolean

requirementsobject

issueslist of objectsOptional

Errors

422

Orders Validate Draft V1request Unprocessable Entity Error