Precheck

POST

/shipping/orders/drafts/build_precheck/v1

POST

/shipping/orders/drafts/build_precheck/v1

1 const url = 'https://localhost:8000/shipping/orders/drafts/build_precheck/v1';
2 const options = {
3   method: 'POST',
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   "valid": true,
3   "unresolvable_contact_ids": [
4     "contact_12345"
5   ],
6   "unresolvable_coordinator": false,
7   "unresolvable_coordinator_shipper_account_ids": [
8     "account_67890"
9   ],
10   "unresolvable_driver_ids": [
11     "driver_54321"
12   ],
13   "unresolvable_off_chrt_executor_org_data_ids": [
14     "executor_data_98765"
15   ],
16   "unresolvable_off_chrt_shipper": false
17 }

Reports whether an order builder request’s references resolve. | authz: min_org_role=operator | (OrderBuilderReq) -> (OrderTemplateResolvabilityRes)

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

order_template_coreobjectOptional

Build input. Required if order_template_id is omitted. When both are provided, this edited core is used instead of the saved template.

order_template_idstringOptional

Saved-template provenance. Required if order_template_core is omitted. When provided, it is authorized for the caller and marked used when the draft opens.

stream_order_parsing_progress_updatesbooleanOptionalDefaults to true

Response

Successful Response

validboolean

unresolvable_contact_idslist of stringsOptional

unresolvable_coordinatorbooleanOptionalDefaults to false

unresolvable_coordinator_shipper_account_idslist of stringsOptional

unresolvable_driver_idslist of stringsOptional

unresolvable_off_chrt_executor_org_data_idslist of stringsOptional

unresolvable_off_chrt_shipperbooleanOptionalDefaults to false

Errors

422

Drafts Build Precheck V1request Unprocessable Entity Error