Validate draft

GET

/shipping/order_drafts/validate/v1/:order_id

GET

/shipping/order_drafts/validate/v1/:order_id

1 const url = 'https://localhost:8000/shipping/order_drafts/validate/v1/order_id';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

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     "order_has_coordinator": true,
8     "order_has_shipper": true,
9     "order_has_task_groups": true,
10     "task_groups_have_valid_task_sequence": true,
11     "task_groups_have_valid_tasks": true,
12     "tasks_have_valid_actions": true,
13     "tasks_have_valid_cargo": true
14   },
15   "issues": [
16     {
17       "requirement_key": "order_has_coordinator",
18       "scope": {
19         "cargo_id": null,
20         "task_group_id": "tg-12345",
21         "task_id": null
22       }
23     }
24   ]
25 }

Validates the draft order for staging and returns requirement results. | () -> (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 objects

Errors

422

Order Drafts Validate V1request Unprocessable Entity Error