PrepareWorkOrderRequest
| Field | Type |
|---|---|
customer_id | string |
page | int32 |
page_size | int32 |
Prepare Work Order
POST /public-api/publicapi.v1.WorkOrder/PrepareWorkOrder
Required scopes: work_order:read and customer:read.
Requires orders read access and customer read access. This is read-only: it does
not create a draft, reserve a location, or change customer data.
{ "customerId": "<customer-id>", "page": 1, "pageSize": 25 }Returns locations, each with field (id, name, label) and a formatted
addressSummary limited to 500 characters. Only active, populated location
fields visible through the actor’s current Customer View are returned. Hidden
fields are excluded before values are read and before pagination. Raw customer
field JSON is not exposed.
page defaults to 1 and pageSize to 25, maximum 100. Increment page while
hasMore is true; page values above 1,000,000 are invalid. Locations are sorted
by case-insensitive field name, then ID. An empty list means there are no visible
populated locations on that page, not permission to invent a location ID.
Use the returned labels and address summaries to choose a location, then pass
its field.id as locationDataFieldId to
Create Work Order. Inventory location
IDs are a different resource and are not valid substitutes.
Generated Reference
POST /public-api/publicapi.v1.WorkOrder/PrepareWorkOrder Lists populated customer locations visible through the actor's current Customer View. Use the returned labels to ask which location to select.
PrepareWorkOrderResponse
| Field | Type |
|---|---|
locations | repeated WorkOrderLocation |
page | int32 |
page_size | int32 |
has_more | bool |