{ "openapi": "3.1.0", "info": { "title": "Nash API", "version": "1.0.0" }, "servers": [ { "url": "https://api.sandbox.usenash.com", "description": "Sandbox API" }, { "url": "https://api.sandbox.ap-southeast-2.usenash.com", "description": "Sandbox API (Australia)" }, { "url": "https://api.usenash.com", "description": "Production API" }, { "url": "https://api.ap-southeast-2.usenash.com", "description": "Production API (Australia)" } ], "paths": { "/v1/activities/calculate-schedule": { "post": { "tags": [ "Driver Scheduling" ], "summary": "Calculate a driver schedule", "description": "Queues a driver-scheduling run (DSP) and returns its activity id. DSP assigns the org's drivers (from their shifts) to fixed multi-stop loads (orders grouped by delivery day and optimization_parameters.sequence_group) over `days` delivery days from `plan_from`, under US DOT hours of service, at the lowest cost, sending what own drivers can't cover to the request's fallbacks. The first `commit_days` days are saved as routes with planned drivers, replacing that day's earlier DSP routes; `commit_days=0` is a dry run that saves nothing. `driver_clocks` injects drivers' hours-of-service state; clocks from earlier committed runs persist. Result load IDs are `:`, using the planning time zone. Poll GET /v1/activities/{id} until status is SUCCESS or FAILED; the schedule is in `result`.", "operationId": "schedules_v1_calculate_schedule_route_calculate_schedule_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateScheduleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateScheduleResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/activities/{id}/dispatch": { "post": { "tags": [ "Route" ], "summary": "Dispatch Optimized Orders", "description": "Dispatch orders from an optimization activity to delivery providers. Creates jobs and assigns them to providers based on the optimized routes.", "operationId": "dispatch_optimized_orders_v1_activities__string_id__dispatch_post", "parameters": [ { "name": "id", "in": "path", "description": "Activity id", "required": true, "schema": { "title": "Id", "type": "string", "description": "Activity id", "example": "act_123" }, "example": "act_123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchOptimizationInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/activities/{id}/save-routes": { "post": { "tags": [ "Route" ], "summary": "Save Optimization Routes", "description": "Save the optimized routes from an optimization activity. Creates route records with stops and travel metrics based on the optimization results.", "operationId": "routes_v1_save_optimization_routes_activities__string_id__save_routes_post", "parameters": [ { "name": "id", "in": "path", "description": "Activity id", "required": true, "schema": { "title": "Id", "type": "string", "description": "Activity id", "example": "act_123" }, "example": "act_123" } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/activities/{id}/unassigned-comparison": { "get": { "tags": [ "Optimization Run Comparison" ], "summary": "Compare an optimization run with the previous run", "description": "Compares a completed route optimization run that left orders unassigned with the previous applied run of the same store, pick shift and target day. Returns the field-level difference of the solver input, the dropped orders, and the cause classes that match. An expected non-result (no dropped orders, no previous run, no stored solver input) is a 200 with its own `outcome`.", "operationId": "optimization_run_comparison_v1_get_unassigned_comparison_route__string_id__unassigned_comparison_get", "parameters": [ { "name": "id", "in": "path", "description": "Activity id", "required": true, "schema": { "title": "Id", "type": "string", "description": "Activity id", "example": "act_123" }, "example": "act_123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnassignedComparison" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/activities/{id}/unassigned-resolve": { "get": { "tags": [ "Optimization Run Re-solve" ], "summary": "Read the re-solve of an optimization run that dropped orders", "description": "Returns the result of solving a run that newly dropped orders, and the previous run, again with their stored inputs. `reading` says whether the change between the runs caused the drop. `status` is `pending` while the solves run, and `not_requested` when none was queued or the result has expired. Both are a 200.", "operationId": "optimization_run_resolve_v1_get_unassigned_resolve_route__string_id__unassigned_resolve_get", "parameters": [ { "name": "id", "in": "path", "description": "Activity id", "required": true, "schema": { "title": "Id", "type": "string", "description": "Activity id", "example": "act_123" }, "example": "act_123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/ai/detect-dropoff-anomaly": { "post": { "tags": [ "AI Functions" ], "summary": "Detect dropoff anomalies for a delivery", "description": "Runs the dropoff anomaly detection agent over a delivery's photo + coordinates history.", "operationId": "detect_dropoff_anomaly_v1_ai_detect_dropoff_anomaly_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DetectDropoffAnomalyInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/ai/mask-face-in-photo": { "post": { "tags": [ "AI Functions" ], "summary": "Mask faces in a photo", "description": "Runs the face-masking agent; returns a URL for the masked copy.", "operationId": "mask_face_in_photo_v1_ai_mask_face_in_photo_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MaskFaceInPhotoInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/ai/verify-photo": { "post": { "tags": [ "AI Functions" ], "summary": "Verify a delivery photo via LLM", "description": "Runs the proof-of-delivery / pickup / signature photo verification agent against the latest matching photo attached to the job, or against the job photo named by image_url.", "operationId": "verify_photo_v1_ai_verify_photo_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyPhotoInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/batch_job": { "post": { "tags": [ "Batch Job" ], "summary": "Create Batch Job", "description": "Create a batch job containing multiple packages for multi-stop delivery. Each package has its own pickup and dropoff locations within a single job.", "operationId": "create_batch_job_v1_batch_job_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatchJobInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedBatchJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/billing/usage": { "get": { "tags": [ "Billing" ], "summary": "Get billing usage", "description": "Return invoice-aligned billable order and delivery counts for recent periods.", "operationId": "billing_v1_get_billing_usage_route_usage_get", "parameters": [ { "name": "granularity", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/BillingUsageGranularity", "default": "month" } }, { "name": "periods", "in": "query", "required": false, "schema": { "title": "Periods", "maximum": 12, "minimum": 1.0, "type": "integer", "default": 6 } }, { "name": "stripe_account_identifier", "in": "query", "required": false, "schema": { "title": "Stripe Account Identifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingUsageResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/contracts": { "get": { "tags": [ "Contracts" ], "summary": "List Contracts", "description": "List contracts visible to the authenticated organization. Returns a slim summary payload by default; pass include=details for the full record. Supports keyset pagination via the cursor returned in next_cursor.", "operationId": "contracts_v1_list_contracts_route_get", "parameters": [ { "name": "active_only", "in": "query", "required": false, "schema": { "title": "Active Only", "type": "boolean", "default": true } }, { "name": "provider_id", "in": "query", "required": false, "schema": { "title": "Provider Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "only_latest_version", "in": "query", "required": false, "schema": { "title": "Only Latest Version", "type": "boolean", "default": true } }, { "name": "include", "in": "query", "required": false, "schema": { "title": "Include", "enum": [ "summary", "details" ], "type": "string", "default": "summary" } }, { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "maximum": 500, "minimum": 1.0, "type": "integer", "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "title": "Cursor", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContractsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/courier": { "post": { "tags": [ "Couriers" ], "summary": "Create a courier", "description": "Register a new courier for the organization's internal fleet with contact and vehicle details.", "operationId": "couriers_v1_create_courier_route_courier_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCourierInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourierResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/couriers": { "get": { "tags": [ "Couriers" ], "summary": "Get all couriers", "description": "List all couriers registered for the organization's internal fleet.", "operationId": "couriers_v1_get_couriers_route_couriers_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourierResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-window": { "post": { "tags": [ "Delivery Windows" ], "summary": "Create a single delivery window", "description": "Create a delivery window defining an available time slot for scheduled deliveries. Delivery windows are associated with a store location and have capacity limits.", "operationId": "create_delivery_window_v1_delivery_window_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeliveryWindowInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-window/{id}": { "get": { "tags": [ "Delivery Windows" ], "summary": "Get a delivery window", "description": "Retrieve a single delivery window by ID, including its time slot, capacity, and status.", "operationId": "get_delivery_window_v1_delivery_window__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "The id of the delivery window", "required": true, "schema": { "title": "Id", "type": "string", "description": "The id of the delivery window", "example": "dlw_abc|10:00|12:00|2025-10-22" }, "example": "dlw_abc|10:00|12:00|2025-10-22" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Delivery Windows" ], "summary": "Delete a delivery window", "description": "Delete a delivery window by ID. Deleted windows can be restored using the restore endpoint.", "operationId": "delete_delivery_window_v1_delivery_window__string_id__delete", "parameters": [ { "name": "id", "in": "path", "description": "The id of the delivery window", "required": true, "schema": { "title": "Id", "type": "string", "description": "The id of the delivery window", "example": "dlw_abc|10:00|12:00|2025-10-22" }, "example": "dlw_abc|10:00|12:00|2025-10-22" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-window/{id}/disable": { "patch": { "tags": [ "Delivery Windows" ], "summary": "Disable a delivery window", "description": "Disable a delivery window so it is no longer available for new bookings. Existing bookings are not affected.", "operationId": "disable_delivery_window_v1_delivery_window__string_id__disable_patch", "parameters": [ { "name": "id", "in": "path", "description": "The id of the delivery window", "required": true, "schema": { "title": "Id", "type": "string", "description": "The id of the delivery window", "example": "dlw_abc|10:00|12:00|2025-10-22" }, "example": "dlw_abc|10:00|12:00|2025-10-22" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-window/{id}/enable": { "patch": { "tags": [ "Delivery Windows" ], "summary": "Enable a delivery window", "description": "Enable a previously disabled delivery window, making it available for booking.", "operationId": "enable_delivery_window_v1_delivery_window__string_id__enable_patch", "parameters": [ { "name": "id", "in": "path", "description": "The id of the delivery window", "required": true, "schema": { "title": "Id", "type": "string", "description": "The id of the delivery window", "example": "dlw_abc|10:00|12:00|2025-10-22" }, "example": "dlw_abc|10:00|12:00|2025-10-22" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-window/{id}/restore": { "patch": { "tags": [ "Delivery Windows" ], "summary": "Restore a delivery window", "description": "Restore a previously deleted delivery window, making it active again.", "operationId": "restore_delivery_window_v1_delivery_window__string_id__restore_patch", "parameters": [ { "name": "id", "in": "path", "description": "The id of the delivery window", "required": true, "schema": { "title": "Id", "type": "string", "description": "The id of the delivery window", "example": "dlw_abc|10:00|12:00|2025-10-22" }, "example": "dlw_abc|10:00|12:00|2025-10-22" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-windows": { "post": { "tags": [ "Delivery Windows" ], "summary": "Create multiple delivery windows", "description": "Create multiple delivery windows in a single request. Each window defines an available time slot with capacity for a store location.", "operationId": "create_delivery_windows_v1_delivery_windows_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeliveryWindowsInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Delivery Windows" ], "summary": "Delete multiple delivery windows", "description": "Delete multiple delivery windows in a single request. Deleted windows can be restored using the restore endpoint.", "operationId": "delete_delivery_windows_v1_delivery_windows_delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsOperationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Delivery Windows" ], "summary": "Update multiple delivery windows", "description": "Update multiple existing delivery windows in a single request. Only provided fields are updated for each window.", "operationId": "update_delivery_windows_v1_delivery_windows_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDeliveryWindowsInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-windows/disable": { "patch": { "tags": [ "Delivery Windows" ], "summary": "Disable multiple delivery windows", "description": "Disable multiple delivery windows in a single request so they are no longer available for new bookings.", "operationId": "disable_delivery_windows_v1_delivery_windows_disable_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsOperationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-windows/enable": { "patch": { "tags": [ "Delivery Windows" ], "summary": "Enable multiple delivery windows", "description": "Enable multiple previously disabled delivery windows in a single request.", "operationId": "enable_delivery_windows_v1_delivery_windows_enable_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsOperationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-windows/restore": { "patch": { "tags": [ "Delivery Windows" ], "summary": "Restore multiple delivery windows", "description": "Restore multiple previously deleted delivery windows in a single request.", "operationId": "restore_delivery_windows_v1_delivery_windows_restore_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsOperationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/delivery-windows/upsert": { "post": { "tags": [ "Delivery Windows" ], "summary": "Upsert multiple delivery windows", "description": "Create or update multiple delivery windows in a single request. Existing windows are matched by ID for updates; new windows are created.", "operationId": "upsert_delivery_windows_v1_delivery_windows_upsert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDeliveryWindowsInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryWindowsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/dispatch-and-manifest": { "post": { "tags": [ "Shipping" ], "summary": "Dispatch and Manifest Orders", "description": "Create, autodispatch, and manifest shipping orders in a single request. Each order is created, autodispatched using the org's dispatch strategy, then manifested with the provider it landed on. Per-order failures are returned in `errors` instead of aborting the batch. `shippingDetails` on an order, if provided, is folded into `orderMetadata.shipping_details` before create so providers can consume it during manifest.", "operationId": "dispatch_and_manifest_v1_dispatch_and_manifest_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchAndManifestInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchAndManifestResponseSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/dispatch/evaluate": { "post": { "tags": [ "Dispatch Strategies" ], "summary": "Evaluate dynamic dispatch", "description": "Evaluate dispatch rules and rank providers without creating a job or order.", "operationId": "evaluate_dispatch_v1_dispatch_evaluate_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateDispatchInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluateDispatchOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/eligible_delivery_windows": { "get": { "tags": [ "Delivery Windows" ], "summary": "Get eligible delivery windows for order", "description": "Find delivery windows available for a specific order based on the order's store location and requirements. Requires either order_id or external_order_id. Optionally filter by time range and requested capacity.", "operationId": "get_eligible_delivery_windows_v1_eligible_delivery_windows_get", "parameters": [ { "name": "orderId", "in": "query", "description": "The order for which to return eligible delivery windows.", "required": false, "schema": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The order for which to return eligible delivery windows.", "default": null, "example": "ord_1234567890" }, "example": "ord_1234567890" }, { "name": "externalOrderId", "in": "query", "description": "The external order id for which to return eligible delivery windows.", "required": false, "schema": { "title": "Externalorderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external order id for which to return eligible delivery windows.", "default": null, "example": "ext_1234567890" }, "example": "ext_1234567890" }, { "name": "startTime", "in": "query", "description": "The range start for delivery windows.", "required": true, "schema": { "title": "Starttime", "type": "string", "description": "The range start for delivery windows.", "format": "date-time", "example": "2024-10-06T00:00:00Z" }, "example": "2024-10-06T00:00:00Z" }, { "name": "endTime", "in": "query", "description": "The range end for delivery windows.", "required": true, "schema": { "title": "Endtime", "type": "string", "description": "The range end for delivery windows.", "format": "date-time", "example": "2024-10-07T00:00:00Z" }, "example": "2024-10-07T00:00:00Z" }, { "name": "requestedCapacity", "in": "query", "description": "Optionally specify the requested capacity for the delivery windows.", "required": false, "schema": { "title": "Requestedcapacity", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Optionally specify the requested capacity for the delivery windows.", "default": null, "example": 10.0 }, "example": 10.0 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibleDeliveryWindowsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/embed-sessions": { "post": { "tags": [ "Embed Sessions" ], "summary": "Mint Embed Session", "description": "Mint an Embed Session for one widget, one parent origin, and an explicit set of resources. Returns the browser envelope: `client_secret`, `expires_at`, `session_id`, `api_region`. Forward it to your page as-is; the client secret is the only value that authenticates the widget, and it is returned once.\n\nPass `refresh_session_id` to replace a live session before it expires. A replacement may narrow the parent's scopes and resources or keep them; widening requires a fresh mint.\n\nDenials are deliberately uniform: `FORBIDDEN` covers every refusal, so a failed request never reveals whether a resource exists. Quote the `X-REQUEST-ID` response header when asking Nash why a specific call was denied; it is present on success and failure alike, and error bodies repeat it as `RequestID`.", "operationId": "embed_sessions_v1_mint_embed_session_route_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbedSessionMintRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbedSessionEnvelope" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/feedback/external_identifier/{external_identifier}": { "post": { "tags": [ "Feedback" ], "summary": "Add Delivery Feedback by External Identifier", "description": "Submit feedback for a completed delivery using your external identifier instead of the Nash delivery ID.", "operationId": "add_delivery_feedback_by_external_id_v1_feedback_external_identifier__string_external_identifier__post", "parameters": [ { "name": "externalIdentifier", "in": "path", "description": "External identifier for the job", "required": true, "schema": { "title": "Externalidentifier", "type": "string", "description": "External identifier for the job", "example": "ext_123" }, "example": "ext_123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFeedbackInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/feedback/{delivery_id}": { "post": { "tags": [ "Feedback" ], "summary": "Add Delivery Feedback", "description": "Submit feedback for a completed delivery, such as a rating or comments about the delivery experience.", "operationId": "add_delivery_feedback_v1_feedback__string_delivery_id__post", "parameters": [ { "name": "deliveryId", "in": "path", "description": "Delivery ID", "required": true, "schema": { "title": "Deliveryid", "type": "string", "description": "Delivery ID", "example": "dlv_123" }, "example": "dlv_123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFeedbackInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedbackOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/files/{token}": { "get": { "tags": [ "Files" ], "summary": "Open a file", "description": "Redirect (302) to a short-lived link for a file your organization owns, such as a proof-of-delivery photo. The link in `secure_url` does not expire; the link it redirects to does, after a few minutes, so open `secure_url` again rather than storing the redirect target. Do not forward your API key to the redirect target.", "operationId": "files_v1_redeem_file_route_files__token__get", "parameters": [ { "name": "token", "in": "path", "description": "The file link token, as it appears in `secure_url`.", "required": true, "schema": { "title": "Token", "type": "string", "description": "The file link token, as it appears in `secure_url`." } } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/flags": { "post": { "tags": [ "Annotate" ], "summary": "Create Flag", "description": "Create a flag annotation on a delivery or job to mark it for attention or follow-up.", "operationId": "create_flag_v1_flags_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFlagInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/fleet/deliveries": { "patch": { "tags": [ "Fleet" ], "summary": "Bulk Update Deliveries", "description": "Apply updates to up to 100 deliveries in a single request. Each item is keyed by exactly one of `deliveryId` or `packageExternalIdentifier` (your own id set on the package at creation), plus the same field set as the single-delivery endpoint. The per-item result echoes back the key you sent under `deliveryId`. Per-item failures come back as a structured error in the response and do not affect the rest of the batch.", "operationId": "deliveries_v1_bulk_update_deliveries_route_patch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeliveryUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeliveryUpdateResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/fleet/deliveries/{delivery_id}": { "patch": { "tags": [ "Fleet" ], "summary": "Update Delivery", "description": "Apply a partial update \u2014 such as status, courier location, proof of delivery, picked items, courier identity, or ETAs \u2014 to a delivery your organization owns. Only available for deliveries fulfilled by your own fleet (not by a third-party courier integration). Returns the updated delivery.", "operationId": "deliveries_v1_update_delivery_route__delivery_id__patch", "parameters": [ { "name": "delivery_id", "in": "path", "description": "The Nash delivery id to update.", "required": true, "schema": { "title": "Delivery Id", "type": "string", "description": "The Nash delivery id to update." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliverySerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/fleet/driver-groups": { "get": { "tags": [ "Fleet" ], "summary": "List Driver Groups", "description": "List the driver groups in your internal fleet. Only active groups are returned unless `activeOnly=false`. Supports keyset pagination via the cursor returned in `nextCursor`, ordered by original group creation time and stable group ID, newest first. Each page returns the latest group data; versioning a group does not change its paging position. Pages are live reads, so newly created groups or changes to visibility may require a new pass.", "operationId": "driver_groups_v1_list_driver_groups_route_get", "parameters": [ { "name": "activeOnly", "in": "query", "required": false, "schema": { "title": "Activeonly", "type": "boolean", "default": true } }, { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "maximum": 500, "minimum": 1.0, "type": "integer", "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "title": "Cursor", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDriverGroupsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/fleet/driver-groups/upsert": { "put": { "tags": [ "Fleet" ], "summary": "Upsert Driver Group", "description": "Create or update a driver group in your internal fleet, keyed on your own `externalIdentifier`. Sending the same `externalIdentifier` again updates the existing group; the response's `created` field tells you which happened. Omitted fields are left unchanged. To disable a group, upsert with `isActive: false` \u2014 there is no delete call. `driverIds` replaces the full list of your drivers in the group. New members require an active group; existing members may be kept or removed while the group is inactive.", "operationId": "driver_groups_v1_upsert_driver_group_route_upsert_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverGroupUpsert" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverGroupUpsertResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/fleet/driver-groups/{first_version_contract_id}": { "get": { "tags": [ "Fleet" ], "summary": "Get Driver Group", "description": "Get one driver group, including the drivers of your organization in it.", "operationId": "driver_groups_v1_get_driver_group_route__first_version_contract_id__get", "parameters": [ { "name": "first_version_contract_id", "in": "path", "required": true, "schema": { "title": "First Version Contract Id", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverGroupReadDetailed" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/fleet/drivers/upsert": { "put": { "tags": [ "Fleet" ], "summary": "Upsert Driver", "description": "Create or update a driver in your internal fleet, keyed on your own `externalIdentifier`. There is no separate create vs. update call \u2014 sending the same `externalIdentifier` again updates the existing driver. The response's `created` field tells you which happened. To disable a driver, upsert with `isShiftActive: false` (or `enabled: false`) \u2014 there is no separate delete/disable call.", "operationId": "drivers_v1_upsert_driver_route_upsert_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CourierUpsert" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/health-check": { "get": { "tags": [ "Miscellaneous" ], "summary": "Server Health Check", "description": "Returns the current server status. Use this to verify API connectivity and availability.", "operationId": "public_health_check_endpoint_v1_health_check_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthCheckResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/hub-scanning/orders/{order_id}": { "get": { "tags": [ "Hub Scanning" ], "summary": "Get order receipt, condition and expected placement", "operationId": "hub_scanning_v1_get_hub_order_orders__string_order_id__get", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "title": "Orderid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubOrderRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/hub-scanning/orders/{order_id}/operations": { "post": { "tags": [ "Hub Scanning" ], "summary": "Record a receipt or supervisor disposition", "operationId": "hub_scanning_v1_apply_hub_order_operation_orders__string_order_id__operations_post", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "title": "Orderid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubOrderOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubOrderRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/hub-scanning/receipts": { "post": { "tags": [ "Hub Scanning" ], "summary": "Receive a known package at a hub, including unrouted packages", "operationId": "hub_scanning_v1_receive_hub_package_receipts_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubReceiptRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubReceiptResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/hub-scanning/routes/{identifier}": { "get": { "tags": [ "Hub Scanning" ], "summary": "Get a hub route scanning manifest", "operationId": "hub_scanning_v1_get_hub_scan_manifest_routes__string_identifier__get", "parameters": [ { "name": "identifier", "in": "path", "required": true, "schema": { "title": "Identifier", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubScanManifest" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/hub-scanning/routes/{route_id}/labels": { "post": { "tags": [ "Hub Scanning" ], "summary": "Generate rack and package labels from a current hub route manifest", "operationId": "hub_scanning_v1_generate_hub_labels_routes__string_route_id__labels_post", "parameters": [ { "name": "routeId", "in": "path", "required": true, "schema": { "title": "Routeid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubLabelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubLabelResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/hub-scanning/routes/{route_id}/scans": { "post": { "tags": [ "Hub Scanning" ], "summary": "Stage one scanned package on a route rack", "operationId": "hub_scanning_v1_stage_hub_scan_routes__string_route_id__scans_post", "parameters": [ { "name": "routeId", "in": "path", "required": true, "schema": { "title": "Routeid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubScanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubScanResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/inventory": { "get": { "tags": [ "Store Catalog" ], "summary": "Get inventory", "description": "List inventory levels with pagination. Filter by external store location ID or external product ID.", "operationId": "get_inventory_pagination_v1_inventory_get", "parameters": [ { "name": "pageIndex", "in": "query", "required": false, "schema": { "title": "Pageindex", "minimum": 0.0, "type": "integer", "default": 0, "example": 0 }, "example": 0 }, { "name": "numResultsPerPage", "in": "query", "required": false, "schema": { "title": "Numresultsperpage", "minimum": 1.0, "type": "integer", "default": 100, "example": 100 }, "example": 100 }, { "name": "search", "in": "query", "required": false, "schema": { "title": "Search", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "example": "organic apples" }, "example": "organic apples" }, { "name": "ids", "in": "query", "required": false, "schema": { "title": "Ids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "example": "pro_123,pro_456" }, "example": "pro_123,pro_456" }, { "name": "skus", "in": "query", "required": false, "schema": { "title": "Skus", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "example": "SKU-001,SKU-002" }, "example": "SKU-001,SKU-002" }, { "name": "semanticSearch", "in": "query", "required": false, "schema": { "title": "Semanticsearch", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "example": "fresh fruit for smoothies" }, "example": "fresh fruit for smoothies" }, { "name": "externalStoreLocationId", "in": "query", "required": false, "schema": { "title": "Externalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "externalProductId", "in": "query", "required": false, "schema": { "title": "Externalproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryPaginationOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Store Catalog" ], "summary": "Create or update inventory", "description": "Create or update inventory levels for products at specific store locations. Rows referencing an unknown product or store location are skipped and returned in the same array with `errorCode`/`errorMessage` set; the rest of the batch still commits.", "operationId": "upsert_inventory_v1_inventory_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreInventoryListInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreInventoryListOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/inventory/sync": { "post": { "tags": [ "Inventory" ], "summary": "Sync store inventory catalogs to SFTP", "description": "Trigger a full catalog export+upload for all synced stores (`all: true`) or a specific list of store external ids. Returns the run activity id; per-store export runs asynchronously.", "operationId": "inventory_v1_sync_inventory_catalog_sync_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventorySyncRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventorySyncResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs": { "get": { "tags": [ "Job" ], "summary": "List/Search Jobs", "description": "List jobs (deliveries) with filters, sorting, and pagination. Returns a slim payload suitable for discovery; use GET /v1/jobs/ for full details.", "operationId": "list_jobs_v1_jobs_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "maximum": 100, "minimum": 1.0, "type": "integer", "default": 25, "example": 25 }, "example": 25 }, { "name": "offset", "in": "query", "required": false, "schema": { "title": "Offset", "minimum": 0.0, "type": "integer", "default": 0, "example": 0 }, "example": 0 }, { "name": "sortBy", "in": "query", "description": "Sort field (e.g. created_at, pickup_start_time)", "required": false, "schema": { "title": "Sortby", "type": "string", "description": "Sort field (e.g. created_at, pickup_start_time)", "default": "created_at" } }, { "name": "sortDirection", "in": "query", "description": "ASC or DESC", "required": false, "schema": { "title": "Sortdirection", "type": "string", "description": "ASC or DESC", "default": "DESC" } }, { "name": "startDate", "in": "query", "description": "Defaults to 3 days ago.", "required": false, "schema": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Defaults to 3 days ago.", "default": null } }, { "name": "endDate", "in": "query", "description": "Defaults to 7 days from now so in-flight and scheduled deliveries are included.", "required": false, "schema": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Defaults to 7 days from now so in-flight and scheduled deliveries are included.", "default": null } }, { "name": "deliveryStatuses", "in": "query", "description": "Comma-separated delivery statuses (e.g. created,accepted_by_courier,delivered)", "required": false, "schema": { "title": "Deliverystatuses", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated delivery statuses (e.g. created,accepted_by_courier,delivered)", "default": null } }, { "name": "providerNames", "in": "query", "description": "Comma-separated provider names", "required": false, "schema": { "title": "Providernames", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated provider names", "default": null } }, { "name": "courierNames", "in": "query", "description": "Comma-separated courier names", "required": false, "schema": { "title": "Couriernames", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated courier names", "default": null } }, { "name": "tags", "in": "query", "description": "Comma-separated job tags", "required": false, "schema": { "title": "Tags", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated job tags", "default": null } }, { "name": "packageTags", "in": "query", "description": "Comma-separated package tags", "required": false, "schema": { "title": "Packagetags", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated package tags", "default": null } }, { "name": "pickupStoreLocationIds", "in": "query", "description": "Comma-separated", "required": false, "schema": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated", "default": null } }, { "name": "dropoffStoreLocationIds", "in": "query", "description": "Comma-separated", "required": false, "schema": { "title": "Dropoffstorelocationids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated", "default": null } }, { "name": "search", "in": "query", "description": "Free-form search across IDs, external identifiers, short reference codes, addresses, and courier/customer names. For an exact match on a single field, use the dedicated filter (e.g. short_reference_code).", "required": false, "schema": { "title": "Search", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-form search across IDs, external identifiers, short reference codes, addresses, and courier/customer names. For an exact match on a single field, use the dedicated filter (e.g. short_reference_code).", "default": null } }, { "name": "shortReferenceCode", "in": "query", "description": "Exact match on the 7-digit short reference code shown on delivery cards. Codes are non-unique; multiple jobs may be returned. When provided, the default date window is widened to 90 days so older jobs are discoverable.", "required": false, "schema": { "title": "Shortreferencecode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Exact match on the 7-digit short reference code shown on delivery cards. Codes are non-unique; multiple jobs may be returned. When provided, the default date window is widened to 90 days so older jobs are discoverable.", "default": null } }, { "name": "customerName", "in": "query", "description": "Fuzzy, case-insensitive substring match on the end customer's name (pickup or dropoff full name) over the denormalized task. Use this to locate a delivery when the caller only knows the customer's name. Matches names only \u2014 not business names, addresses, or courier names (use `search` for broader free-form matching). When provided, the default date window is widened to 90 days so older deliveries are discoverable.", "required": false, "schema": { "title": "Customername", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Fuzzy, case-insensitive substring match on the end customer's name (pickup or dropoff full name) over the denormalized task. Use this to locate a delivery when the caller only knows the customer's name. Matches names only \u2014 not business names, addresses, or courier names (use `search` for broader free-form matching). When provided, the default date window is widened to 90 days so older deliveries are discoverable.", "default": null } }, { "name": "isBatch", "in": "query", "description": "Filter to batch jobs only", "required": false, "schema": { "title": "Isbatch", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter to batch jobs only", "default": null } }, { "name": "hasNotes", "in": "query", "description": "Filter to jobs with notes", "required": false, "schema": { "title": "Hasnotes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter to jobs with notes", "default": null } }, { "name": "city", "in": "query", "description": "Comma-separated pickup/dropoff cities", "required": false, "schema": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated pickup/dropoff cities", "default": null } }, { "name": "state", "in": "query", "description": "Comma-separated pickup/dropoff states", "required": false, "schema": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated pickup/dropoff states", "default": null } }, { "name": "country", "in": "query", "description": "Comma-separated pickup/dropoff countries", "required": false, "schema": { "title": "Country", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated pickup/dropoff countries", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Job" ], "summary": "Create Job", "description": "Create a new delivery job with pickup and dropoff details. A job represents a post-dispatch delivery request. Set quote_request_only=true to get price quotes without dispatching.", "operationId": "create_job_v1_jobs_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJobInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/external_identifier/{externalIdentifier}": { "get": { "tags": [ "Job" ], "summary": "Get Job by External Identifier", "description": "Retrieve a job using your external identifier instead of the Nash job ID. Useful when integrating with external systems that track their own order IDs.", "operationId": "get_job_by_external_id_v1_jobs_external_identifier__string_externalIdentifier__get", "parameters": [ { "name": "externalIdentifier", "in": "path", "description": "job external identifier", "required": true, "schema": { "title": "Externalidentifier", "type": "string", "description": "job external identifier" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Job" ], "summary": "Create or Update Job by External Identifier", "description": "Create a new job or update an existing one using your external identifier. If a job with the given external identifier exists, it is updated; otherwise a new job is created. Set autodispatch=true to automatically dispatch after creation.", "operationId": "create_or_update_job_by_external_id_v1_jobs_external_identifier__string_externalIdentifier__post", "parameters": [ { "name": "externalIdentifier", "in": "path", "description": "job external identifier", "required": true, "schema": { "title": "Externalidentifier", "type": "string", "description": "job external identifier" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJobInputSerializerAndAutodispatch" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/external_identifier/{externalIdentifier}/autodispatch": { "post": { "tags": [ "Job" ], "summary": "Autodispatch job by external identifier", "description": "Automatically dispatch an existing job using your external identifier. Requests quotes from providers and selects the best one based on the organization's dispatch strategy.", "operationId": "autodispatch_job_by_external_id_v1_jobs_external_identifier__string_externalIdentifier__autodispatch_post", "parameters": [ { "name": "externalIdentifier", "in": "path", "description": "job external identifier", "required": true, "schema": { "title": "Externalidentifier", "type": "string", "description": "job external identifier" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/external_identifier/{externalIdentifier}/cancel": { "post": { "tags": [ "Job" ], "summary": "Cancel Job by External Identifier", "description": "Cancel an active job using your external identifier. Cancels the delivery with the assigned provider and updates the job status.", "operationId": "_cancel_job_by_external_identifier_v1_jobs_external_identifier__string_externalIdentifier__cancel_post", "parameters": [ { "name": "externalIdentifier", "in": "path", "description": "job external identifier", "required": true, "schema": { "title": "Externalidentifier", "type": "string", "description": "job external identifier" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{id}": { "get": { "tags": [ "Job" ], "summary": "Get Job", "description": "Retrieve a job by its ID, including all job configurations, tasks, deliveries, and quotes. Pass `compressed_payload=true` by default \u2014 it drops the quotes and failedQuotes arrays and collapses advancedTask to just its id, which typically shrinks the response 10x+. Only omit it (or pass false) when the caller explicitly needs quote details: pricing, provider selection, or failed-dispatch error messages.", "operationId": "get_job_v1_jobs__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "job id", "required": true, "schema": { "title": "Id", "type": "string", "description": "job id" } }, { "name": "compressedPayload", "in": "query", "description": "Return a slimmer job payload by excluding the full `quotes` and `failedQuotes` arrays and reducing `advancedTask` to just `{id}`. Prefer `compressed_payload=true` by default for status / ETA / tracking / cancellation flows \u2014 it can shrink responses by 10x+ on jobs that shopped many providers. Set to false (or omit) only when the caller needs quote data: pricing breakdowns, provider selection rationale, or failed-dispatch error messages.", "required": false, "schema": { "title": "Compressedpayload", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return a slimmer job payload by excluding the full `quotes` and `failedQuotes` arrays and reducing `advancedTask` to just `{id}`. Prefer `compressed_payload=true` by default for status / ETA / tracking / cancellation flows \u2014 it can shrink responses by 10x+ on jobs that shopped many providers. Set to false (or omit) only when the caller needs quote data: pricing breakdowns, provider selection rationale, or failed-dispatch error messages.", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Job" ], "summary": "Update Job by JobID/ExternalIdentifier", "description": "Update an existing job's details such as pickup/dropoff times, addresses, or metadata. The id can be a Nash job ID or your external identifier.", "operationId": "update_job_v1_jobs__string_id__patch", "parameters": [ { "name": "id", "in": "path", "description": "Job ID or External Identifier", "required": true, "schema": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job ID or External Identifier" } }, { "name": "jobConfigurationId", "in": "path", "description": "Job Configuration ID (for updating a package in a batch job)", "required": true, "schema": { "title": "Jobconfigurationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job Configuration ID (for updating a package in a batch job)", "default": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateJobInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{id}/autodispatch": { "post": { "tags": [ "Job" ], "summary": "Autodispatch job", "description": "Automatically dispatch an existing job using the organization's dispatch strategy. Requests quotes from providers and selects the best one based on configured rules.", "operationId": "autodispatch_job_v1_jobs__string_id__autodispatch_post", "parameters": [ { "name": "id", "in": "path", "description": "job id", "required": true, "schema": { "title": "Id", "type": "string", "description": "job id" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{id}/rebook": { "post": { "tags": [ "Job" ], "summary": "Rebook Job", "description": "Cancel the existing job and create a new one with updated details. The original job is canceled before the new job is created from the provided data.", "operationId": "rebook_job_v1_jobs__string_id__rebook_post", "parameters": [ { "name": "id", "in": "path", "description": "job id", "required": true, "schema": { "title": "Id", "type": "string", "description": "job id" } }, { "name": "compressedPayload", "in": "query", "description": "Return a slimmer job payload by excluding the full `quotes` and `failedQuotes` arrays and reducing `advancedTask` to just `{id}`. Prefer `compressed_payload=true` by default for status / ETA / tracking / cancellation flows \u2014 it can shrink responses by 10x+ on jobs that shopped many providers. Set to false (or omit) only when the caller needs quote data: pricing breakdowns, provider selection rationale, or failed-dispatch error messages.", "required": false, "schema": { "title": "Compressedpayload", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Return a slimmer job payload by excluding the full `quotes` and `failedQuotes` arrays and reducing `advancedTask` to just `{id}`. Prefer `compressed_payload=true` by default for status / ETA / tracking / cancellation flows \u2014 it can shrink responses by 10x+ on jobs that shopped many providers. Set to false (or omit) only when the caller needs quote data: pricing breakdowns, provider selection rationale, or failed-dispatch error messages.", "default": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RebookJobBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{id}/refresh": { "post": { "tags": [ "Job" ], "summary": "Refresh job", "description": "Refresh a job's status by fetching the latest delivery information from the assigned provider. Useful for syncing state when provider webhooks may have been missed.", "operationId": "refresh_job_v1_jobs__string_id__refresh_post", "parameters": [ { "name": "id", "in": "path", "description": "job id", "required": true, "schema": { "title": "Id", "type": "string", "description": "job id" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{id}/{jobConfigurationId}": { "patch": { "tags": [ "Batch Job" ], "summary": "Update Job by JobID/ExternalIdentifier and Job Configuration ID", "description": "Update a specific package within a batch job. Use the job configuration ID to target a particular package's details.", "operationId": "update_job_v1_jobs__string_id___string_jobConfigurationId__patch", "parameters": [ { "name": "id", "in": "path", "description": "Job ID or External Identifier", "required": true, "schema": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job ID or External Identifier" } }, { "name": "jobConfigurationId", "in": "path", "description": "Job Configuration ID (for updating a package in a batch job)", "required": true, "schema": { "title": "Jobconfigurationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Job Configuration ID (for updating a package in a batch job)", "default": null } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateJobInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedBatchJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{jobId}/batch/{batchId}/refresh_quotes": { "post": { "tags": [ "Batch Job" ], "summary": "Refresh Quotes by Job ID and Batch ID", "description": "Request fresh price quotes from delivery providers for all tasks in a batch. Replaces existing quotes with updated pricing for the entire batch.", "operationId": "refresh_quotes_batch_v1_jobs__string_jobId__batch__string_batchId__refresh_quotes_post", "parameters": [ { "name": "jobId", "in": "path", "description": "job id", "required": true, "schema": { "title": "Jobid", "type": "string", "description": "job id" } }, { "name": "batchId", "in": "path", "description": "batch id", "required": true, "schema": { "title": "Batchid", "type": "string", "description": "batch id" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshBatchQuotesOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{jobId}/cancel": { "post": { "tags": [ "Job" ], "summary": "Cancel Job by Job ID", "description": "Cancel an active job and its associated deliveries. Cancels the delivery with the assigned provider and updates the job status.", "operationId": "cancel_job_v1_jobs__string_jobId__cancel_post", "parameters": [ { "name": "jobId", "in": "path", "description": "job id", "required": true, "schema": { "title": "Jobid", "type": "string", "description": "job id" } }, { "name": "objectId", "in": "path", "description": "Task ID or Job Configuration ID", "required": true, "schema": { "title": "Objectid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Task ID or Job Configuration ID", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{jobId}/tasks/{taskId}/delivery_incident": { "post": { "tags": [ "Job" ], "summary": "Create delivery incident", "description": "Report a delivery incident such as a damaged package, missing items, or late delivery. Creates an incident record linked to the specified task.", "operationId": "delivery_incident_v1_jobs__string_jobId__tasks__string_taskId__delivery_incident_post", "parameters": [ { "name": "jobId", "in": "path", "description": "job id", "required": true, "schema": { "title": "Jobid", "type": "string", "description": "job id" } }, { "name": "taskId", "in": "path", "description": "task id", "required": true, "schema": { "title": "Taskid", "type": "string", "description": "task id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryIncidentInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryIncidentOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{jobId}/tasks/{taskId}/quotes": { "post": { "tags": [ "Job" ], "summary": "Select Quote by Job ID and Task ID", "description": "Select the winning quote for a specific task within a job. Deprecated: prefer the Select Quote endpoint instead.", "operationId": "select_quote_task_v1_jobs__string_jobId__tasks__string_taskId__quotes_post", "parameters": [ { "name": "jobId", "in": "path", "description": "job id", "required": true, "schema": { "title": "Jobid", "type": "string", "description": "job id" } }, { "name": "taskId", "in": "path", "description": "task id", "required": true, "schema": { "title": "Taskid", "type": "string", "description": "task id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectQuoteInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectTaskQuoteOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{jobId}/tasks/{taskId}/refresh_quotes": { "post": { "tags": [ "Job" ], "summary": "Refresh Quotes by Job ID and Task ID", "description": "Request fresh price quotes from delivery providers for a specific task. Replaces any existing quotes with updated pricing.", "operationId": "refresh_quotes_task_v1_jobs__string_jobId__tasks__string_taskId__refresh_quotes_post", "parameters": [ { "name": "jobId", "in": "path", "description": "job id", "required": true, "schema": { "title": "Jobid", "type": "string", "description": "job id" } }, { "name": "taskId", "in": "path", "description": "task id", "required": true, "schema": { "title": "Taskid", "type": "string", "description": "task id" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshQuotesOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{jobId}/{objectId}/cancel": { "post": { "tags": [ "Batch Job" ], "summary": "Cancel Job by Job ID and Task or Job Configuration ID", "description": "Cancel a specific task or job configuration within a batch job. The objectId can be a task ID (tsk_ prefix) or job configuration ID (cfg_ prefix).", "operationId": "cancel_job_v1_jobs__string_jobId___string_objectId__cancel_post", "parameters": [ { "name": "jobId", "in": "path", "description": "job id", "required": true, "schema": { "title": "Jobid", "type": "string", "description": "job id" } }, { "name": "objectId", "in": "path", "description": "Task ID or Job Configuration ID", "required": true, "schema": { "title": "Objectid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Task ID or Job Configuration ID", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/jobs/{jobId}/{taskId}/reassign": { "post": { "tags": [ "Job" ], "summary": "Reassign task by Job ID and Task ID", "description": "Cancel the current delivery attempt and create a new task for reassignment. A new task is created on the same job configuration, allowing a different provider to fulfill the delivery.", "operationId": "reassign_task_v1_jobs__string_jobId___string_taskId__reassign_post", "parameters": [ { "name": "jobId", "in": "path", "description": "job id", "required": true, "schema": { "title": "Jobid", "type": "string", "description": "job id" } }, { "name": "taskId", "in": "path", "description": "task id", "required": true, "schema": { "title": "Taskid", "type": "string", "description": "task id" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReassignTaskInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReturnedJobMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/manifest": { "post": { "tags": [ "Shipping" ], "summary": "Manifest Orders", "description": "Create manifests for dispatched shipping orders. Groups orders by store location and provider, then generates manifest documents (e.g. AusPost order summaries).", "operationId": "create_manifest_v1_manifest_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManifestOrdersInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManifestOrdersResponseSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/messages/send": { "post": { "tags": [ "Messaging" ], "summary": "Send Message", "description": "Send a one-off SMS or email to the courier, customer, or pickup business associated with a delivery. The recipient is resolved from the order's contact details on file (phone for SMS, email for email).", "operationId": "send_message_v1_v1_messages_send_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageInput" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/notes": { "post": { "tags": [ "Annotate" ], "summary": "Create Note", "description": "Add a text note annotation to a delivery or job for internal record-keeping.", "operationId": "create_note_v1_notes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNoteInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/notification-triggers": { "get": { "tags": [ "Notifications" ], "summary": "List Notification Triggers", "description": "List notification triggers configured on the authenticated organization. Use the `Nash-Org-Id` header to scope the request to a specific org (e.g. a child org).", "operationId": "list_notification_triggers_v1_notification_triggers_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNotificationTriggersResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Notifications" ], "summary": "Create Notification Trigger", "description": "Create a notification trigger on the authenticated organization. The request body is a discriminated union on `type`: each trigger type (see GET /v1/notification-triggers/templates) has its own typed `parameters` shape in the OpenAPI schema. An invalid `type` returns a 400 listing all valid types. Use the `Nash-Org-Id` header to scope creation to a specific org (e.g. a child org).", "operationId": "create_notification_trigger_v1_notification_triggers_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNotificationTriggerInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTriggerResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/notification-triggers/catalog": { "get": { "tags": [ "Notifications" ], "summary": "Get Notification Trigger Catalog", "description": "The full notification-trigger catalog. Each entry describes a trigger's `type` slug, human `title`, the `value` used to subscribe automations, the `entityType` (route/delivery/task/order/activity), its `statuses` vocabulary, the JSON Schema of its create `parameters`, and the `supportedFilters` / `supportedActions`. The shared `filterCriteria` (dispatch strategies, contracts, zones, metadata conditions) and `actions` are described once at the top level. Designed for agents and humans to discover what can be automated and how.", "operationId": "get_notification_trigger_catalog_v1_notification_triggers_catalog_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationTriggerCatalogResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/notification-triggers/templates": { "get": { "tags": [ "Notifications" ], "summary": "List Notification Trigger Templates", "description": "List pre-defined notification trigger templates. Each template has a `type` slug (e.g. 'tasks_attempts_exhausted') and a human-readable `title` (e.g. 'Tasks Attempts Exhausted'). Use the `type` when creating a trigger via POST /v1/notification-triggers.", "operationId": "list_notification_trigger_templates_v1_notification_triggers_templates_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNotificationTriggerTemplatesResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/notification/{id}/trigger": { "post": { "tags": [ "Notifications" ], "summary": "Trigger Notification", "description": "Manually trigger a notification for a specific delivery event. The notification is sent using the configured channel and template for the trigger.", "operationId": "trigger_notification_v1_notification__string_id__trigger_post", "parameters": [ { "name": "id", "in": "path", "description": "Notification trigger ID", "required": true, "schema": { "title": "Id", "type": "string", "description": "Notification trigger ID", "example": "ntf_123" }, "example": "ntf_123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotificationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerNotificationOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/optimization-activities/cancel": { "post": { "tags": [ "Optimization Activities" ], "summary": "Cancel optimization activities", "description": "Cancel optimization activities by id. Partial success: each id reports its own outcome (STOPPED, INTERRUPTING, DISCARD_ON_RETURN, or an error), so a sibling that already finished does not block the ones still running.", "operationId": "optimization_activities_v1_cancel_optimization_activities_route_cancel_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOptimizationActivitiesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOptimizationActivitiesResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/optimization-strategies": { "get": { "tags": [ "Optimization Strategies" ], "summary": "List Optimization Strategies", "description": "Returns all optimization strategies for the authenticated organization (including soft-deleted).", "operationId": "list_optimization_strategies_v1_optimization_strategies_get", "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Optimization Strategies" ], "summary": "Create Optimization Strategy", "description": "Create a new optimization strategy for the authenticated organization. A strategy configures how orders are grouped into routes (service times, pickup-time windows, contracts, store locations, zones, and optional cron schedules).", "operationId": "create_optimization_strategy_v1_optimization_strategies_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOptimizationStrategyInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/optimization-strategies/{id}": { "get": { "tags": [ "Optimization Strategies" ], "summary": "Get Optimization Strategy", "description": "Returns a single optimization strategy by id.", "operationId": "get_optimization_strategy_v1_optimization_strategies__string_id__get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Optimization Strategies" ], "summary": "Delete Optimization Strategy", "description": "Soft-delete an optimization strategy. Fails if the strategy is referenced by an automation logic or an active automation rule.", "operationId": "delete_optimization_strategy_v1_optimization_strategies__string_id__delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Optimization Strategies" ], "summary": "Update Optimization Strategy", "description": "Update an existing optimization strategy. Only provided fields are updated. Supplying `optimization_schedules` replaces the existing schedules.", "operationId": "update_optimization_strategy_v1_optimization_strategies__string_id__patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOptimizationStrategyInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/optimization-strategies/{id}/route-restrictions": { "put": { "tags": [ "Route Restrictions" ], "summary": "Set Strategy Route Restrictions", "description": "Bulk-replace the route restrictions attached to ````. Empty list detaches all restrictions.", "operationId": "route_restrictions_strategy_attach_v1_set_strategy_restrictions_route__id__route_restrictions_put", "parameters": [ { "name": "id", "in": "path", "description": "The OptimizationStrategy id (``ost_\u2026``).", "required": true, "schema": { "title": "Id", "type": "string", "description": "The OptimizationStrategy id (``ost_\u2026``)." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStrategyRestrictionsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetStrategyRestrictionsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/optimization/fleet-projection": { "post": { "tags": [ "Optimization Fleet Projection" ], "summary": "Project the optimizer's effective fleet", "description": "Project fleet membership, counts, dispatch settings, configured capabilities and depot IDs for a single-store LOS VRP solve without shifts. TSP, on-demand, locked-route and engine solves are refused when a digest is supplied. The versioned digest binds these fields at approval and checks them after scenario overrides when expectedFleetDigest is supplied on the optimize action. Order-derived eligibility capability tokens are checked separately and excluded from the digest. Profile, capacity, route limits, speed, costs, parking, breaks, timing, depot attributes and renewal parameters are not covered. Requested contract IDs are informational; resolved version IDs are bound. Recompute the digest by removing digest and each contract's requested_contract_ids, then SHA-256 hashing UTF-8 JSON with recursively sorted keys, compact separators and unescaped Unicode. Accepts 1\u2013100 contract IDs, each 1\u2013255 characters. Read-only. Returns 400 for shift-selection knobs, 404 for an unreadable store or contract, and 409 for incomplete conversion or fleet drift.", "operationId": "fleet_projection_v1_project_fleet_route_fleet_projection_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetProjectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FleetProjection" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/options_group": { "get": { "tags": [ "Dispatch Strategies" ], "summary": "Get dispatch strategies", "description": "List all dispatch strategies (options groups) configured for the organization. Dispatch strategies define provider selection rules, fallback logic, and quoting behavior.", "operationId": "list_options_group_v1_options_group_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOptionsGroupOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Dispatch Strategies" ], "summary": "Create dispatch strategy", "description": "Create a new dispatch strategy (options group) with provider selection rules, fallback logic, and quoting configuration.", "operationId": "create_options_group_v1_options_group_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsGroupInputMixin" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsGroupInputMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/options_group/{id}": { "delete": { "tags": [ "Dispatch Strategies" ], "summary": "Delete dispatch strategy", "description": "Delete a dispatch strategy (options group) by ID. Orders using this strategy will need to be reassigned to another strategy.", "operationId": "delete_options_group_v1_options_group__string_id__delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsGroupInputMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Dispatch Strategies" ], "summary": "Update dispatch strategy", "description": "Update an existing dispatch strategy's provider selection rules, fallback logic, or quoting configuration. Only provided fields are updated.", "operationId": "update_options_group_v1_options_group__string_id__patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsGroupInputMixin" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OptionsGroupInputMixin" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order": { "post": { "tags": [ "Order" ], "summary": "Create Order", "description": "Create a pre-dispatch order with pickup and dropoff details. Orders are flexible data structures that become packages when dispatched to a provider.", "operationId": "create_order_v1_order_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/external-identifier/{externalId}": { "post": { "tags": [ "Order" ], "summary": "Create or update order by external identifier", "description": "Create a new order or update an existing one using your external identifier. If an order with the given external identifier exists, it is updated; otherwise a new order is created.", "operationId": "upsert_order_by_external_id_v1_order_external_identifier__string_externalId__post", "parameters": [ { "name": "externalId", "in": "path", "description": "The external id of the order to update", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "The external id of the order to update", "example": "1234567890" }, "example": "1234567890" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInputWithReturnFirstQuoteApiOnly" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/external-identifier/{externalId}/autodispatch": { "post": { "tags": [ "Order" ], "summary": "Autodispatch order by external identifier", "description": "Dispatch an order using your external identifier and the organization's dispatch strategy. Creates a job, requests quotes, and automatically selects the best quote.", "operationId": "autodispatch_order_by_external_id_v1_order_external_identifier__string_externalId__autodispatch_post", "parameters": [ { "name": "externalId", "in": "path", "description": "The external id of the order to update", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "The external id of the order to update", "example": "1234567890" }, "example": "1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/external-identifier/{externalId}/delivery-window": { "post": { "tags": [ "Order" ], "summary": "Upsert order by external identifier with delivery window", "description": "Create or update an order by external identifier and associate it with a delivery window. The order is linked to the specified delivery window for scheduled delivery.", "operationId": "upsert_order_with_delivery_window_v1_order_external_identifier__string_externalId__delivery_window_post", "parameters": [ { "name": "externalId", "in": "path", "description": "The external id of the order to update", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "The external id of the order to update", "example": "1234567890" }, "example": "1234567890" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderWithDeliveryWindowInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderWithDeliveryWindowOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/external-identifier/{externalId}/delivery-window/book": { "post": { "tags": [ "Delivery Windows" ], "summary": "Book a delivery window for order", "description": "Reserve a delivery window for an order identified by external ID. The booking holds capacity in the window until confirmed or revoked.", "operationId": "book_delivery_window_v1_order_external_identifier__string_externalId__delivery_window_book_post", "parameters": [ { "name": "externalId", "in": "path", "description": "The external id of the order to update", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "The external id of the order to update", "example": "1234567890" }, "example": "1234567890" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BookDeliveryWindowInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/external-identifier/{externalId}/delivery-window/confirm": { "post": { "tags": [ "Delivery Windows" ], "summary": "Confirm a delivery window for order", "description": "Confirm a previously booked delivery window for an order. Finalizes the booking and commits the capacity reservation.", "operationId": "confirm_delivery_window_v1_order_external_identifier__string_externalId__delivery_window_confirm_post", "parameters": [ { "name": "externalId", "in": "path", "description": "The external id of the order to update", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "The external id of the order to update", "example": "1234567890" }, "example": "1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/external-identifier/{externalId}/delivery-window/revoke": { "post": { "tags": [ "Delivery Windows" ], "summary": "Revoke a delivery window for order", "description": "Revoke a previously booked delivery window for an order. Releases the capacity reservation and disassociates the window from the order.", "operationId": "revoke_delivery_window_v1_order_external_identifier__string_externalId__delivery_window_revoke_post", "parameters": [ { "name": "externalId", "in": "path", "description": "The external id of the order to update", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "The external id of the order to update", "example": "1234567890" }, "example": "1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/get_quotes": { "post": { "tags": [ "Order" ], "summary": "Get order quotes", "description": "Request delivery price quotes from available providers for an order. Returns the order with attached quotes that can be selected to dispatch.", "operationId": "get_order_quotes_v1_order_get_quotes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInputWithReturnFirstQuoteApiOnly" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/refresh_quotes": { "post": { "tags": [ "Order" ], "summary": "Refresh order quotes", "description": "Request fresh price quotes from delivery providers for an existing order. Replaces any existing quotes with updated pricing from available providers.", "operationId": "refresh_order_quotes_v1_order_refresh_quotes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshOrderQuotesInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshOrderQuotesOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/{id}": { "get": { "tags": [ "Order" ], "summary": "Get order", "description": "Retrieve a single order by ID, including its pickup/dropoff details, status, and metadata.", "operationId": "get_order_v1_order__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Order" ], "summary": "Archive order", "description": "Archive (soft-delete) an order. Archived orders are hidden from default listings but can be restored using the unarchive endpoint.", "operationId": "archive_order_v1_order__string_id__delete", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Order" ], "summary": "Update order", "description": "Update an existing pre-dispatch order's details such as addresses, times, or metadata. Only provided fields are updated.", "operationId": "update_order_v1_order__string_id__patch", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInputWithReturnFirstQuoteApiOnly" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/{id}/autodispatch": { "post": { "tags": [ "Order" ], "summary": "Autodispatch order", "description": "Dispatch an order using the organization's dispatch strategy. Creates a job, requests quotes from providers, and automatically selects the best quote.", "operationId": "autodispatch_order_v1_order__string_id__autodispatch_post", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FullJobPayload" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/{id}/confirm": { "patch": { "tags": [ "Order" ], "summary": "Confirm order", "description": "Confirm a valid order, changing its status from 'valid' to 'confirmed'.", "operationId": "confirm_order_v1_order__string_id__confirm_patch", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/{id}/documents": { "get": { "tags": [ "Order" ], "summary": "Get order documents", "description": "Retrieve documents associated with an order such as shipping labels or proof of delivery. Set load_data=true to include the document content in the response.", "operationId": "get_order_documents_v1_order__string_id__documents_get", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" }, { "name": "loadData", "in": "query", "description": "Whether to load the document data and return it as part of the response.", "required": true, "schema": { "title": "Loaddata", "type": "boolean", "description": "Whether to load the document data and return it as part of the response." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDocumentResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/{id}/events": { "post": { "tags": [ "Order" ], "summary": "Add custom event to order", "description": "Add a custom event to an order's event timeline. Rate limited to 3 requests per second per order with a max payload of 1KB.", "operationId": "add_order_event_v1_order__string_id__events_post", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEventInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddEventOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/order/{id}/unarchive": { "patch": { "tags": [ "Order" ], "summary": "Unarchive order", "description": "Restore a previously archived order, making it visible in default listings again.", "operationId": "unarchive_order_v1_order__string_id__unarchive_patch", "parameters": [ { "name": "id", "in": "path", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "required": true, "schema": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/orders": { "get": { "tags": [ "Order" ], "summary": "List/Search Orders", "description": "List orders with filters, sorting, and pagination. Returns a slim payload suitable for discovery; use GET /v1/order/ for full details.", "operationId": "list_orders_v1_orders_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "maximum": 100, "minimum": 1.0, "type": "integer", "default": 25, "example": 25 }, "example": 25 }, { "name": "offset", "in": "query", "required": false, "schema": { "title": "Offset", "minimum": 0.0, "type": "integer", "default": 0, "example": 0 }, "example": 0 }, { "name": "sortBy", "in": "query", "description": "Sort field: created_at, updated_at, value_cents, pickup_start_time, pickup_end_time, dropoff_start_time, dropoff_end_time", "required": false, "schema": { "title": "Sortby", "type": "string", "description": "Sort field: created_at, updated_at, value_cents, pickup_start_time, pickup_end_time, dropoff_start_time, dropoff_end_time", "default": "created_at", "example": "created_at" }, "example": "created_at" }, { "name": "sortDirection", "in": "query", "description": "Sort direction: ASC or DESC", "required": false, "schema": { "title": "Sortdirection", "type": "string", "description": "Sort direction: ASC or DESC", "default": "DESC", "example": "DESC" }, "example": "DESC" }, { "name": "startDate", "in": "query", "description": "Lower bound for pickup/dropoff/created-at window. Defaults to 30 days ago.", "required": false, "schema": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Lower bound for pickup/dropoff/created-at window. Defaults to 30 days ago.", "default": null } }, { "name": "endDate", "in": "query", "description": "Upper bound for pickup/dropoff/created-at window. Defaults to now.", "required": false, "schema": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Upper bound for pickup/dropoff/created-at window. Defaults to now.", "default": null } }, { "name": "status", "in": "query", "description": "Comma-separated list of order statuses (e.g. active,pending_confirmation)", "required": false, "schema": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list of order statuses (e.g. active,pending_confirmation)", "default": null, "example": "active,pending_confirmation" }, "example": "active,pending_confirmation" }, { "name": "ids", "in": "query", "description": "Comma-separated list of order ids. Bypasses date filter when set.", "required": false, "schema": { "title": "Ids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list of order ids. Bypasses date filter when set.", "default": null } }, { "name": "referenceId", "in": "query", "description": "Exact order reference id. May return multiple orders and bypasses the date filter when set.", "required": false, "schema": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Exact order reference id. May return multiple orders and bypasses the date filter when set.", "default": null, "example": "REF-123" }, "example": "REF-123" }, { "name": "tags", "in": "query", "description": "Comma-separated list of tags", "required": false, "schema": { "title": "Tags", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list of tags", "default": null } }, { "name": "search", "in": "query", "description": "Free-form search", "required": false, "schema": { "title": "Search", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-form search", "default": null } }, { "name": "hasRoute", "in": "query", "description": "Filter by route state: has_route, no_route, or all", "required": false, "schema": { "title": "Hasroute", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by route state: has_route, no_route, or all", "default": null, "example": "all" }, "example": "all" }, { "name": "pickupStoreLocationIds", "in": "query", "description": "Comma-separated store location ids", "required": false, "schema": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated store location ids", "default": null } }, { "name": "dropoffStoreLocationIds", "in": "query", "description": "Comma-separated store location ids", "required": false, "schema": { "title": "Dropoffstorelocationids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated store location ids", "default": null } }, { "name": "city", "in": "query", "description": "Comma-separated list of pickup or dropoff cities", "required": false, "schema": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list of pickup or dropoff cities", "default": null } }, { "name": "state", "in": "query", "description": "Comma-separated list of pickup or dropoff states", "required": false, "schema": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list of pickup or dropoff states", "default": null } }, { "name": "country", "in": "query", "description": "Comma-separated list of pickup or dropoff countries", "required": false, "schema": { "title": "Country", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list of pickup or dropoff countries", "default": null } }, { "name": "pickupBusinessName", "in": "query", "description": "Comma-separated list", "required": false, "schema": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list", "default": null } }, { "name": "dropoffBusinessName", "in": "query", "description": "Comma-separated list", "required": false, "schema": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list", "default": null } }, { "name": "creationSource", "in": "query", "description": "Comma-separated list", "required": false, "schema": { "title": "Creationsource", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list", "default": null } }, { "name": "dispatchStrategyId", "in": "query", "description": "Comma-separated list", "required": false, "schema": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated list", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdersListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Order" ], "summary": "Create Orders", "description": "Create multiple pre-dispatch orders in a single request. Each order is created independently with its own pickup and dropoff details.", "operationId": "create_orders_v1_orders_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrdersInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdersOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/orders/bulk": { "post": { "tags": [ "Order" ], "summary": "Create, update, upsert, or delete orders asynchronously in bulk", "description": "Submit a bulk operation to create, update, upsert, or delete multiple orders asynchronously. Returns a bulk operation ID that can be polled for results using the GET bulk endpoint.", "operationId": "orders_bulk_operation_v1_orders_bulk_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrdersBulkOperationInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/orders/bulk/{id}": { "get": { "tags": [ "Order" ], "summary": "Get response from asynchronous bulk order operation", "description": "Retrieve the results of a previously submitted bulk order operation. Returns the status and individual results for each order in the batch.", "operationId": "get_orders_bulk_response_v1_orders_bulk__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the bulk operation", "required": true, "schema": { "title": "Id", "type": "string", "description": "The ID of the bulk operation", "example": "act_1234567890" }, "example": "act_1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBulkOperationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/orders/external-identifier": { "post": { "tags": [ "Order" ], "summary": "Create or update orders by external identifier", "description": "Create or update multiple orders by external identifier (if an order with a given external identifier exists it is updated, otherwise a new one is created).\n\nAlways returns **HTTP 200** with one entry per input order, at the same index. Each entry is either the upserted order (carries `id`) or an error object `{externalId, errorCode, message}` when that single order failed \u2014 a failure on one order does not fail the batch, so inspect each entry (presence of `errorCode` = failure) rather than relying on the HTTP status. Soft validation issues still return as order entries with `validationErrors` populated and `status=needs_attention`. For a structured `{results, summary}` envelope, use `POST /v2/orders/upsert/bulk`.", "operationId": "create_or_update_orders_by_external_id_v1_orders_external_identifier_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrdersInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertOrdersByExternalIdOutputExample" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/orders/external-identifier/{external_id}/undispatch": { "post": { "tags": [ "Order" ], "summary": "Undispatch an order", "description": "Un-dispatch a route-based order: cancel its active task and provider delivery, remove it from its route (re-syncing the linked batch), and revert it to the `valid` status. Returns the updated order. Errors if the order is not dispatched, or is not associated with a route.", "operationId": "orders_undispatch_v1_undispatch_order_by_external_id_route_external_identifier__external_id__undispatch_post", "parameters": [ { "name": "externalId", "in": "path", "description": "The external id of the order to update", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "The external id of the order to update", "example": "1234567890" }, "example": "1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/orders/{order_id}/undispatch": { "post": { "tags": [ "Order" ], "summary": "Undispatch an order by id", "description": "Un-dispatch a route-based order by id: cancel its active task and provider delivery, remove it from its route (re-syncing the linked batch), and revert it to the `valid` status. Returns the updated order. Errors if the order is not dispatched, or is not associated with a route.", "operationId": "orders_undispatch_v1_undispatch_order_by_id_route__order_id__undispatch_post", "parameters": [ { "name": "orderId", "in": "path", "description": "The id of the order (starts with \"ord_\").", "required": true, "schema": { "title": "Orderid", "type": "string", "description": "The id of the order (starts with \"ord_\").", "example": "ord_1234567890" }, "example": "ord_1234567890" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/organization-management/notifications/deny-list": { "get": { "tags": [ "Notifications" ], "summary": "Get contacts in the deny list.", "description": "Retrieve all contacts in the organization's notification deny list. Contacts on this list will not receive delivery notifications.", "operationId": "_get_deny_list_v1_organization_management_notifications_deny_list_get", "parameters": [ { "name": "orgId", "in": "query", "description": "The organization id to get the deny list for.", "required": false, "schema": { "title": "Orgid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The organization id to get the deny list for.", "default": null } }, { "name": "page", "in": "query", "description": "Use this parameter to show more pages of results (page starts at 0)..", "required": false, "schema": { "title": "Page", "type": "integer", "description": "Use this parameter to show more pages of results (page starts at 0)..", "default": 0 } }, { "name": "pageSize", "in": "query", "description": "The number of items to return per page.", "required": false, "schema": { "title": "Pagesize", "type": "integer", "description": "The number of items to return per page.", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DenyListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Notifications" ], "summary": "Add a contact to the deny list.", "description": "Add a contact (phone number or email) to the organization's notification deny list. The contact will no longer receive delivery notifications.", "operationId": "_add_contact_to_deny_list_v1_organization_management_notifications_deny_list_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddContactToDenyListSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DenyList" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Notifications" ], "summary": "Remove a contact from the deny list.", "description": "Remove a contact from the organization's notification deny list. The contact will resume receiving delivery notifications.", "operationId": "_remove_contact_from_deny_list_v1_organization_management_notifications_deny_list_delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddContactToDenyListSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/organization-management/roles": { "get": { "tags": [ "Users" ], "summary": "List Roles", "description": "List every RBAC role attached to the calling organization.", "operationId": "users_v1_list_roles_route_roles_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/organization-management/roles/{role_id}/users": { "get": { "tags": [ "Users" ], "summary": "List Users In Role", "description": "List the users that hold ``role_id`` inside the calling organization.", "operationId": "users_v1_list_users_in_role_route_roles__role_id__users_get", "parameters": [ { "name": "role_id", "in": "path", "description": "The Nash role id (``rol_\u2026``).", "required": true, "schema": { "title": "Role Id", "type": "string", "description": "The Nash role id (``rol_\u2026``)." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/organization-management/users": { "get": { "tags": [ "Users" ], "summary": "List Users", "description": "List every user that has at least one role in the calling organization.", "operationId": "users_v1_list_users_route_users_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Users" ], "summary": "Create User", "description": "Create a brand-new Nash user and grant them the supplied roles inside the calling organization. If a user with the supplied email already exists, use ``POST /users/invite`` instead to attach them to this org.", "operationId": "users_v1_create_user_route_users_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/organization-management/users/invite": { "post": { "tags": [ "Users" ], "summary": "Invite Existing User Into Org", "description": "Attach an existing Nash user (looked up by email) to the calling organization with the supplied role ids.", "operationId": "users_v1_invite_user_route_users_invite_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserInvite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/organization-management/users/{user_id}/roles": { "get": { "tags": [ "Users" ], "summary": "List User Roles", "description": "List the roles held by ``user_id`` inside the calling organization.", "operationId": "users_v1_get_user_roles_route_users__user_id__roles_get", "parameters": [ { "name": "user_id", "in": "path", "description": "The Nash user id (``usr_\u2026``).", "required": true, "schema": { "title": "User Id", "type": "string", "description": "The Nash user id (``usr_\u2026``)." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Users" ], "summary": "Add User Roles", "description": "Add one or more existing role ids to ``user_id`` inside the calling org.", "operationId": "users_v1_add_user_roles_route_users__user_id__roles_post", "parameters": [ { "name": "user_id", "in": "path", "description": "The Nash user id (``usr_\u2026``).", "required": true, "schema": { "title": "User Id", "type": "string", "description": "The Nash user id (``usr_\u2026``)." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleIds" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MutationResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Remove User Roles", "description": "Remove the supplied role ids from ``user_id`` inside the calling org. Sending the user's full role set effectively revokes their access.", "operationId": "users_v1_remove_user_roles_route_users__user_id__roles_delete", "parameters": [ { "name": "user_id", "in": "path", "description": "The Nash user id (``usr_\u2026``).", "required": true, "schema": { "title": "User Id", "type": "string", "description": "The Nash user id (``usr_\u2026``)." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleIds" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MutationResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Users" ], "summary": "Replace User Roles", "description": "Replace the user's role set inside the calling org with exactly the supplied role ids. Roles in other orgs are unaffected.", "operationId": "users_v1_replace_user_roles_route_users__user_id__roles_patch", "parameters": [ { "name": "user_id", "in": "path", "description": "The Nash user id (``usr_\u2026``).", "required": true, "schema": { "title": "User Id", "type": "string", "description": "The Nash user id (``usr_\u2026``)." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleIds" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MutationResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/organizations/children": { "get": { "tags": [ "Organizations" ], "summary": "List Child Organizations", "description": "List direct child organizations of the authenticated organization. Use this to discover which org IDs to pass in the `Nash-Org-Id` header when configuring resources (e.g. notification triggers) in a specific child account.", "operationId": "list_organization_children_v1_organizations_children_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationChildrenResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans": { "get": { "tags": [ "Dispatch plans" ], "summary": "List Dispatch Plans", "description": "List the active dispatch plans of your organization, newest first. Filter by `search` (name), `source` and `tags`; page with the `nextCursor` of the previous page and the same filters.", "operationId": "list_dispatch_plans", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "maximum": 500, "minimum": 1.0, "type": "integer", "default": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "title": "Cursor", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "search", "in": "query", "required": false, "schema": { "title": "Search", "anyOf": [ { "maxLength": 256, "pattern": "^[^\\x00]*$", "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "source", "in": "query", "required": false, "schema": { "title": "Source", "anyOf": [ { "enum": [ "orders", "routes", "snapshot" ], "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "tags", "in": "query", "required": false, "schema": { "title": "Tags", "type": "array", "items": { "maxLength": 64, "minLength": 1, "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanList" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Dispatch plans" ], "summary": "Create Dispatch Plan", "description": "Create a draft dispatch plan from `orderIds` (source `orders`, the default), or copy `routeIds` and the unassigned `orderIds` into a `snapshot` that leaves the live routes as they are. To take live routes into a plan, which archives them, use `POST /v1/plans:from-routes`. Needs `write.plan`; a plan source or label rollout that is off for your organization returns 403. Returns the plan id, its draft revision and how many orders start unplanned.", "operationId": "create_dispatch_plan", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDispatchPlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedDispatchPlan" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}": { "get": { "tags": [ "Dispatch plans" ], "summary": "Get Dispatch Plan", "description": "A dispatch plan's draft as a summary: totals, issues, one line per route and the first unplanned order ids. Read a route's stops with Get Dispatch Plan Route. `isClean` is false while someone has unsaved changes.", "operationId": "get_dispatch_plan", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanDigest" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/discard": { "post": { "tags": [ "Dispatch plans" ], "summary": "Discard Dispatch Plan Changes", "description": "Return the draft to its last saved version, discarding unsaved changes by anyone. Orders that joined or left the plan since stay as they are. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "discard_dispatch_plan", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanWrite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanWriteResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/optimizations": { "post": { "tags": [ "Dispatch plans" ], "summary": "Start Dispatch Plan Optimization", "description": "Queue a run that re-solves a snapshot plan's routes on their own trucks. Nothing changes until the run is taken; the lease is not held while it runs. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "start_dispatch_plan_optimization", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartDispatchPlanOptimization" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanOptimizationStarted" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/optimizations/{activityId}": { "get": { "tags": [ "Dispatch plans" ], "summary": "Get Dispatch Plan Optimization", "description": "The status of one of the plan's optimization runs; 404 `ACTIVITY_NOT_FOUND` for any other run.", "operationId": "get_dispatch_plan_optimization", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } }, { "name": "activityId", "in": "path", "description": "The optimization run id from its start.", "required": true, "schema": { "title": "Activityid", "type": "string", "description": "The optimization run id from its start." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanOptimization" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/optimizations/{activityId}:take": { "post": { "tags": [ "Dispatch plans" ], "summary": "Take Dispatch Plan Optimization", "description": "Take a `succeeded` run into the plan's draft. Fails with 409 `PLAN_OPTIMIZATION_UNAVAILABLE` and `reason` `not_finished` while the run is `queued` or `running` (poll again), or `not_takeable` for a run that failed or whose result does not fit the plan; and with 409 `PLAN_OPTIMIZATION_STALE` when the draft changed after the run started. `not_takeable` and `PLAN_OPTIMIZATION_STALE` are final for that run: start a new one. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "take_dispatch_plan_optimization", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } }, { "name": "activityId", "in": "path", "description": "The optimization run id from its start.", "required": true, "schema": { "title": "Activityid", "type": "string", "description": "The optimization run id from its start." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanWrite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanOptimizationTaken" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/orders:import": { "post": { "tags": [ "Dispatch plans" ], "summary": "Import Orders Into Dispatch Plan", "description": "Add up to 22,000 orders per request to the plan's unplanned backlog. Orders the plan already holds are reported as unchanged, so a retry is safe. The whole selection is refused when any id is unknown or ineligible (400 `PLAN_SELECTION_INVALID`, naming the ids) or another plan holds one of its orders (409 `ORDER_HELD_BY_PLAN`). More ids than one request takes fail with 422 `VALIDATION_ERRORS`. A plan holds at most 22,000 orders, 1,500 routes and 24,000 stops; an import that would grow it past them is refused with 400 `PLAN_DOCUMENT_INVALID`. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "import_dispatch_plan_orders", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDispatchPlanOrders" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedDispatchPlanOrders" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/orders:move-back": { "post": { "tags": [ "Dispatch plans" ], "summary": "Move Back Dispatch Plan Orders", "description": "Send the selected orders back to the plan they were transferred from; they must all have come from one plan. The other plan takes the orders even while someone has it open; its revision advances and the Planner reloads it. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "move_back_dispatch_plan_orders", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveDispatchPlanOrders" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferredDispatchPlanOrders" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/orders:remove": { "post": { "tags": [ "Dispatch plans" ], "summary": "Remove Dispatch Plan Orders", "description": "Take the selected orders out of the plan, off any draft route they are on. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "remove_dispatch_plan_orders", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveDispatchPlanOrders" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemovedDispatchPlanOrders" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/orders:transfer": { "post": { "tags": [ "Dispatch plans" ], "summary": "Transfer Dispatch Plan Orders", "description": "Move the selected orders into another plan's unplanned orders. The other plan takes the orders even while someone has it open; its revision advances and the Planner reloads it. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "transfer_dispatch_plan_orders", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferDispatchPlanOrders" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferredDispatchPlanOrders" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/routes/{routeId}": { "get": { "tags": [ "Dispatch plans" ], "summary": "Get Dispatch Plan Route", "description": "One route of a dispatch plan's draft, stop by stop: orders, planned arrival, location and window.", "operationId": "get_dispatch_plan_route", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } }, { "name": "routeId", "in": "path", "required": true, "schema": { "title": "Routeid", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanRouteDetail" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/routes:import": { "post": { "tags": [ "Dispatch plans" ], "summary": "Import Routes Into Dispatch Plan", "description": "Take up to 1,500 whole undispatched routes per request into the plan's draft, archiving each live source route; its orders join the plan. Routes the plan already took are reported as unchanged, so a retry is safe. The whole selection is refused when any id is unknown or ineligible (400 `PLAN_SELECTION_INVALID`, naming the ids) or another plan holds one of its orders (409 `ORDER_HELD_BY_PLAN`). More ids than one request takes fail with 422 `VALIDATION_ERRORS`. A plan holds at most 22,000 orders, 1,500 routes and 24,000 stops; an import that would grow it past them is refused with 400 `PLAN_DOCUMENT_INVALID`. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "import_dispatch_plan_routes", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDispatchPlanRoutes" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedDispatchPlanRoutes" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans/{planId}/save": { "post": { "tags": [ "Dispatch plans" ], "summary": "Save Dispatch Plan", "description": "Save the plan's current draft as the version Discard returns to. Fails with 409 `PLAN_LEASE_HELD` (naming `heldBy`) while anyone has the plan open in the Planner, and with 409 `PLAN_REVISION_STALE` (naming `currentRevision`) when the plan changed since `expectedRevision`.", "operationId": "save_dispatch_plan", "parameters": [ { "name": "planId", "in": "path", "required": true, "schema": { "title": "Planid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanWrite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchPlanWriteResult" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/plans:from-routes": { "post": { "tags": [ "Dispatch plans" ], "summary": "Create Dispatch Plan From Routes", "description": "Create a draft dispatch plan that takes whole undispatched `routeIds` and their orders. The live routes are archived and the plan holds their orders. Needs `write.plan`; a plan source or label rollout that is off for your organization returns 403. Returns the plan id, its draft revision and how many orders start unplanned.", "operationId": "create_dispatch_plan_from_routes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDispatchPlanFromRoutesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedDispatchPlan" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/product/external_identifier/{externalIdentifier}": { "get": { "tags": [ "Store Catalog" ], "summary": "Get Product by External Identifier", "description": "Retrieve a product from the store catalog using your external identifier.", "operationId": "get_product_by_external_identifier_v1_product_external_identifier__string_externalIdentifier__get", "parameters": [ { "name": "externalIdentifier", "in": "path", "description": "product external identifier", "required": true, "schema": { "title": "Externalidentifier", "type": "string", "description": "product external identifier", "example": "ext_001" }, "example": "ext_001" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/product/{id}": { "get": { "tags": [ "Store Catalog" ], "summary": "Get Product", "description": "Retrieve a single product from the store catalog by its ID.", "operationId": "get_product_v1_product__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "product id", "required": true, "schema": { "title": "Id", "type": "string", "description": "product id", "example": "prod_123" }, "example": "prod_123" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/products": { "get": { "tags": [ "Store Catalog" ], "summary": "Get products", "description": "List products in the store catalog with pagination and optional filtering. Filter by IDs, SKUs, text search, or semantic search.", "operationId": "get_products_pagination_v1_products_get", "parameters": [ { "name": "pageIndex", "in": "query", "required": false, "schema": { "title": "Pageindex", "minimum": 0.0, "type": "integer", "default": 0, "example": 0 }, "example": 0 }, { "name": "numResultsPerPage", "in": "query", "required": false, "schema": { "title": "Numresultsperpage", "minimum": 1.0, "type": "integer", "default": 100, "example": 100 }, "example": 100 }, { "name": "search", "in": "query", "required": false, "schema": { "title": "Search", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "example": "organic apples" }, "example": "organic apples" }, { "name": "ids", "in": "query", "required": false, "schema": { "title": "Ids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "example": "pro_123,pro_456" }, "example": "pro_123,pro_456" }, { "name": "skus", "in": "query", "required": false, "schema": { "title": "Skus", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "example": "SKU-001,SKU-002" }, "example": "SKU-001,SKU-002" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductsPaginationOutput" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Store Catalog" ], "summary": "Create or update products", "description": "Create new products or update existing ones in the store catalog. Products are matched by external identifier for upsert logic.", "operationId": "upsert_products_v1_products_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductsInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductsOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/providers": { "get": { "tags": [ "Provider" ], "summary": "Get providers", "description": "List all delivery providers configured for the organization, including their status and capabilities.", "operationId": "list_org_providers_v1_providers_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrgProvidersOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/refund-request/update": { "post": { "tags": [ "Job" ], "summary": "Update Refund Request", "description": "Update the status or details of an existing refund request.", "operationId": "update_refund_request_v1_refund_request_update_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRefundRequestInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundRequestResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/refund-request/{id}": { "get": { "tags": [ "Job" ], "summary": "Get Refund Request", "description": "Retrieve a single refund request by its ID, including status and resolution details.", "operationId": "get_refund_request_v1_refund_request__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the refund request.", "required": true, "schema": { "title": "Id", "type": "string", "description": "The ID of the refund request.", "example": "rfrq_01234567890123456789" }, "example": "rfrq_01234567890123456789" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundRequestResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/refund-requests": { "get": { "tags": [ "Job" ], "summary": "Get Refund Requests by Task ID or Job ID", "description": "Retrieve all refund requests associated with a task or job. At least one of task_id or job_id must be provided.", "operationId": "get_refund_requests_v1_refund_requests_get", "parameters": [ { "name": "taskId", "in": "query", "description": "The task ID to filter by.", "required": false, "schema": { "title": "Taskid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The task ID to filter by.", "default": null } }, { "name": "jobId", "in": "query", "description": "The job ID to filter by.", "required": false, "schema": { "title": "Jobid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The job ID to filter by.", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRefundRequestResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/route-restrictions": { "get": { "tags": [ "Route Restrictions" ], "summary": "List Route Restrictions", "description": "List route restrictions in the calling organization's library.", "operationId": "route_restrictions_v1_list_route_restrictions_route_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteRestrictionsListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Route Restrictions" ], "summary": "Create Route Restriction", "description": "Create a new route restriction with one or more avoid polygons.", "operationId": "route_restrictions_v1_create_route_restriction_route_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteRestrictionCreate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteRestrictionRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/route-restrictions/{id}": { "get": { "tags": [ "Route Restrictions" ], "summary": "Get Route Restriction", "description": "Fetch a single route restriction by id.", "operationId": "route_restrictions_v1_get_route_restriction_route__id__get", "parameters": [ { "name": "id", "in": "path", "description": "The Nash route restriction id (``rrs_\u2026``).", "required": true, "schema": { "title": "Id", "type": "string", "description": "The Nash route restriction id (``rrs_\u2026``)." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteRestrictionRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Route Restrictions" ], "summary": "Delete Route Restriction", "description": "Delete a route restriction along with its CoverageArea and Polygon rows.", "operationId": "route_restrictions_v1_delete_route_restriction_route__id__delete", "parameters": [ { "name": "id", "in": "path", "description": "The Nash route restriction id (``rrs_\u2026``).", "required": true, "schema": { "title": "Id", "type": "string", "description": "The Nash route restriction id (``rrs_\u2026``)." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteRouteRestrictionResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Route Restrictions" ], "summary": "Update Route Restriction", "description": "Partially update a route restriction. Omitted fields are left unchanged.", "operationId": "route_restrictions_v1_update_route_restriction_route__id__patch", "parameters": [ { "name": "id", "in": "path", "description": "The Nash route restriction id (``rrs_\u2026``).", "required": true, "schema": { "title": "Id", "type": "string", "description": "The Nash route restriction id (``rrs_\u2026``)." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteRestrictionUpdate" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteRestrictionRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/routes": { "get": { "tags": [ "Route" ], "summary": "List/Search Routes", "description": "List routes with filters and pagination. Returns a slim payload suitable for discovery; use GET /v1/routes/ for full details.", "operationId": "routes_v1_list_routes_routes_get", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "maximum": 100, "minimum": 1.0, "type": "integer", "default": 25, "example": 25 }, "example": 25 }, { "name": "offset", "in": "query", "required": false, "schema": { "title": "Offset", "minimum": 0.0, "type": "integer", "default": 0, "example": 0 }, "example": 0 }, { "name": "sortDirection", "in": "query", "description": "ASC or DESC, applied to created_at", "required": false, "schema": { "title": "Sortdirection", "type": "string", "description": "ASC or DESC, applied to created_at", "default": "DESC" } }, { "name": "startDate", "in": "query", "description": "Defaults to 30 days ago.", "required": false, "schema": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Defaults to 30 days ago.", "default": null } }, { "name": "endDate", "in": "query", "description": "Defaults to now.", "required": false, "schema": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Defaults to now.", "default": null } }, { "name": "tags", "in": "query", "description": "Comma-separated order tags; matches routes with an order carrying any of them", "required": false, "schema": { "title": "Tags", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated order tags; matches routes with an order carrying any of them", "default": null } }, { "name": "search", "in": "query", "description": "Free-form search", "required": false, "schema": { "title": "Search", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-form search", "default": null } }, { "name": "isDispatched", "in": "query", "description": "Filter by dispatched state", "required": false, "schema": { "title": "Isdispatched", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Filter by dispatched state", "default": null } }, { "name": "dispatchStrategyId", "in": "query", "description": "Comma-separated", "required": false, "schema": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated", "default": null } }, { "name": "pickupStoreLocationIds", "in": "query", "description": "Comma-separated", "required": false, "schema": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated", "default": null } }, { "name": "dropoffStoreLocationIds", "in": "query", "description": "Comma-separated", "required": false, "schema": { "title": "Dropoffstorelocationids", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated", "default": null } }, { "name": "city", "in": "query", "description": "Comma-separated pickup/dropoff cities", "required": false, "schema": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated pickup/dropoff cities", "default": null } }, { "name": "state", "in": "query", "description": "Comma-separated pickup/dropoff states", "required": false, "schema": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated pickup/dropoff states", "default": null } }, { "name": "country", "in": "query", "description": "Comma-separated pickup/dropoff countries", "required": false, "schema": { "title": "Country", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated pickup/dropoff countries", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteListPageRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Route" ], "summary": "Create or Update Route", "description": "Create a new route or update an existing one. A route defines an optimized sequence of stops with orders assigned to each stop.", "operationId": "routes_v1_upsert_route_routes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertRouteInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertRouteResponseSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/routes/dispatch": { "post": { "tags": [ "Route" ], "summary": "Dispatch Routes", "description": "Dispatch one or more routes to delivery providers. Creates jobs for each route and assigns them based on the organization's dispatch strategy.", "operationId": "routes_v1_dispatch_routes_routes_dispatch_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRoutesInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DispatchRoutesOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/routes/external-identifier/{external_id}/assign": { "post": { "tags": [ "Route" ], "summary": "Assign or Reassign a Route by external id", "description": "Assign a route to a provider, driver group (contract), courier, or vehicle. Driver group / courier / vehicle accept an internal or external id. Pre-dispatch the assignment is updated in place. Post-dispatch the route is reassigned \u2014 the active assignment is cancelled, live deliveries are cancelled, tasks are recreated and re-quoted, a fresh route assignment is created, and the requested target is applied. Returns the updated route.", "operationId": "routes_v1_assign_route_by_external_id_routes_external_identifier__external_id__assign_post", "parameters": [ { "name": "externalId", "in": "path", "description": "External identifier of the route", "required": true, "schema": { "title": "Externalid", "type": "string", "description": "External identifier of the route", "example": "rte_ext_123" }, "example": "rte_ext_123" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignRouteInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/routes/nearby-couriers": { "get": { "tags": [ "Route" ], "summary": "Find Nearby Couriers", "description": "Nearest couriers on active routes (assigned, started, in progress) to a point, ranked by straight-line distance from each courier's latest GPS ping. Couriers with no recorded ping are omitted. Scope to one depot with store_location_id, and leave out the route being rescued with exclude_route_ids.", "operationId": "routes_v1_find_nearby_couriers_route_routes_nearby_couriers_get", "parameters": [ { "name": "lat", "in": "query", "description": "Latitude to measure from, e.g. the stranded driver.", "required": true, "schema": { "title": "Lat", "maximum": 90.0, "minimum": -90.0, "type": "number", "description": "Latitude to measure from, e.g. the stranded driver." } }, { "name": "lng", "in": "query", "description": "Longitude to measure from.", "required": true, "schema": { "title": "Lng", "maximum": 180.0, "minimum": -180.0, "type": "number", "description": "Longitude to measure from." } }, { "name": "limit", "in": "query", "description": "Maximum couriers to return.", "required": false, "schema": { "title": "Limit", "maximum": 50, "minimum": 1.0, "type": "integer", "description": "Maximum couriers to return.", "default": 5 } }, { "name": "store_location_id", "in": "query", "description": "Only routes carrying an order picked up at this store location.", "required": false, "schema": { "title": "Store Location Id", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Only routes carrying an order picked up at this store location.", "default": null } }, { "name": "exclude_route_ids", "in": "query", "description": "Comma-separated route ids to leave out, along with their couriers, e.g. the route that needs rescuing.", "required": false, "schema": { "title": "Exclude Route Ids", "anyOf": [ { "maxLength": 4096, "type": "string" }, { "type": "null" } ], "description": "Comma-separated route ids to leave out, along with their couriers, e.g. the route that needs rescuing.", "default": null } }, { "name": "max_location_age_minutes", "in": "query", "description": "Ignore couriers whose latest ping is older than this.", "required": false, "schema": { "title": "Max Location Age Minutes", "maximum": 1440, "minimum": 1.0, "type": "integer", "description": "Ignore couriers whose latest ping is older than this.", "default": 30 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NearbyCouriersResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/routes/{id}": { "get": { "tags": [ "Route" ], "summary": "Get Route", "description": "Retrieve a route by ID, including its stops, travel metrics, and associated orders.", "operationId": "routes_v1_get_route_routes__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "Route ID", "required": true, "schema": { "title": "Id", "type": "string", "description": "Route ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/routes/{id}/assign": { "post": { "tags": [ "Route" ], "summary": "Assign or Reassign a Route", "description": "Assign a route to a provider, driver group (contract), courier, or vehicle. Driver group / courier / vehicle accept an internal or external id. Pre-dispatch the assignment is updated in place. Post-dispatch the route is reassigned \u2014 the active assignment is cancelled, live deliveries are cancelled, tasks are recreated and re-quoted, a fresh route assignment is created, and the requested target is applied. Returns the updated route.", "operationId": "routes_v1_assign_route_routes__string_id__assign_post", "parameters": [ { "name": "id", "in": "path", "description": "Route ID", "required": true, "schema": { "title": "Id", "type": "string", "description": "Route ID" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignRouteInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RouteSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/routes/{id}/calculate-timing": { "post": { "tags": [ "Route" ], "summary": "Calculate Route Timing", "description": "Calculate per-stop ETAs and polyline for a route using HERE truck routing. Updates arrival/departure times for each stop and returns the route polyline.", "operationId": "routes_v1_calculate_route_timing_routes__string_id__calculate_timing_post", "parameters": [ { "name": "id", "in": "path", "description": "Route ID", "required": true, "schema": { "title": "Id", "type": "string", "description": "Route ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculateRouteTimingResponseSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/select_quote": { "post": { "tags": [ "Job" ], "summary": "Select Quote", "description": "Select a delivery quote to dispatch the job to a provider. Selecting a quote creates a delivery and begins the fulfillment process with the chosen provider.", "operationId": "select_quote_v1_select_quote_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectQuoteInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelectQuoteOutputSerializer" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/set_store_location_day_capacity": { "post": { "tags": [ "Store Locations" ], "summary": "Set the day capacity for a store location", "description": "Set the delivery capacity for a store location on a specific date. Overrides the default weekly capacity for that particular day.", "operationId": "set_store_location_day_capacity_v1_set_store_location_day_capacity_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationDayCapacityInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/set_store_location_default_capacity": { "post": { "tags": [ "Store Locations" ], "summary": "Set the weekly default capacity for a store location", "description": "Configure the default weekly capacity schedule for a store location. Defines how many orders the location can handle per day of the week.", "operationId": "set_store_location_default_capacity_v1_set_store_location_default_capacity_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationDefaultCapacityInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/shift": { "post": { "tags": [ "Shifts" ], "summary": "Create a shift", "description": "Create a courier shift with start/end times and an assigned store location.", "operationId": "shifts_v1_create_shift_route_shift_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShiftInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/shift/{id}": { "get": { "tags": [ "Shifts" ], "summary": "Get a shift", "description": "Retrieve a single courier shift by ID, including its times, assigned courier, and store location.", "operationId": "shifts_v1_get_shift_route_shift__string_id__get", "parameters": [ { "name": "id", "in": "path", "description": "Shift ID", "required": true, "schema": { "title": "Id", "type": "string", "description": "Shift ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/shifts": { "get": { "tags": [ "Shifts" ], "summary": "Get all shifts", "description": "List courier shifts with optional filtering by time range and store location. Filter by start_time, end_time, store_location_id, or external_store_location_id.", "operationId": "shifts_v1_get_shifts_route_shifts_get", "parameters": [ { "name": "startTime", "in": "query", "description": "The start time of the shifts to list.", "required": true, "schema": { "title": "Starttime", "type": "string", "description": "The start time of the shifts to list.", "format": "date-time", "example": "2025-05-01T00:00:00Z" }, "example": "2025-05-01T00:00:00Z" }, { "name": "endTime", "in": "query", "description": "The end time of the shifts to list.", "required": true, "schema": { "title": "Endtime", "type": "string", "description": "The end time of the shifts to list.", "format": "date-time", "example": "2025-06-01T00:00:00Z" }, "example": "2025-06-01T00:00:00Z" }, { "name": "storeLocationId", "in": "query", "description": "The store location ID to list shifts for.", "required": false, "schema": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The store location ID to list shifts for.", "default": null } }, { "name": "externalStoreLocationId", "in": "query", "description": "The external store location ID to list shifts for.", "required": false, "schema": { "title": "Externalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external store location ID to list shifts for.", "default": null } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/shifts/upsert": { "post": { "tags": [ "Shifts" ], "summary": "Upsert shifts", "description": "Create or update multiple courier shifts in a single request. Existing shifts are matched by ID for updates; new shifts are created.", "operationId": "shifts_v1_upsert_shifts_route_shifts_upsert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShiftsInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShiftResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/shifts/upsert-by-external-id": { "post": { "tags": [ "Shifts" ], "summary": "Upsert shifts by external id", "description": "Atomically create, update or no-op up to 500 shifts keyed by your external_id, in one transaction: any rejected item leaves every other item unwritten. Each shift is a complete planning snapshot (omitted fields are stored as defaults) and may set its courier, vehicle, store location and optimization_params.vehicle_config. Only PLANNED shifts can be written.", "operationId": "shifts_v1_upsert_shifts_by_external_id_route_shifts_upsert_by_external_id_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertShiftsByExternalIdRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertShiftsByExternalIdResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/store_locations": { "get": { "tags": [ "Store Locations" ], "summary": "Get store locations", "description": "List store locations for the organization with pagination. Use size and offset parameters to paginate through results.", "operationId": "store_locations_v1_list_store_locations_route_get", "parameters": [ { "name": "size", "in": "query", "description": "The size of the store locations to return.", "required": false, "schema": { "title": "Size", "type": "integer", "description": "The size of the store locations to return.", "default": 10 } }, { "name": "offset", "in": "query", "description": "The offset of the store locations to return.", "required": false, "schema": { "title": "Offset", "type": "integer", "description": "The offset of the store locations to return.", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListStoreLocationsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Store Locations" ], "summary": "Create store location", "description": "Create a new store location (pickup point) with address, hours, and capacity settings.", "operationId": "store_locations_v1_create_store_location_route_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStoreLocationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/store_locations/coverage": { "get": { "tags": [ "Store Locations" ], "summary": "Get store locations that cover specified location (latitude & longitude, city_zipcode)", "description": "Find store locations whose delivery zones cover a given geographic point. Provide latitude/longitude, city_zipcode, or zipcode to find matching store locations.", "operationId": "get_store_locations_coverage_v1_store_locations_coverage_get", "parameters": [ { "name": "latitude", "in": "query", "description": "The latitude of the location to check coverage for. If used, must specify longitude", "required": false, "schema": { "title": "Latitude", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The latitude of the location to check coverage for. If used, must specify longitude", "default": null, "example": "0.00" }, "example": "0.00" }, { "name": "longitude", "in": "query", "description": "The longitude of the location to check coverage for. If used, must specify latitude", "required": false, "schema": { "title": "Longitude", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The longitude of the location to check coverage for. If used, must specify latitude", "default": null, "example": "0.00" }, "example": "0.00" }, { "name": "cityZipcode", "in": "query", "description": "The city_zipcode pair to check coverage for. The location must have coverage set up using the `City & Zip Code` unique field, not the separate `City` or `Zip Code` fields.", "required": false, "schema": { "title": "Cityzipcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city_zipcode pair to check coverage for. The location must have coverage set up using the `City & Zip Code` unique field, not the separate `City` or `Zip Code` fields.", "default": null, "example": "sanfrancisco_94114" }, "example": "sanfrancisco_94114" }, { "name": "zipcode", "in": "query", "description": "The zipcode to check coverage for.", "required": false, "schema": { "title": "Zipcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zipcode to check coverage for.", "default": null, "example": "94114" }, "example": "94114" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/store_locations/external-identifier/{externalIdentifier}": { "post": { "tags": [ "Store Locations" ], "summary": "Create or update store location by external identifier", "description": "Create a new store location or update an existing one using your external identifier. If a store location with the given external identifier exists, it is updated.", "operationId": "upsert_store_location_by_external_id_v1_store_locations_external_identifier__string_externalIdentifier__post", "parameters": [ { "name": "externalIdentifier", "in": "path", "required": true, "schema": { "title": "Externalidentifier", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStoreLocationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/store_locations/external_identifier/{external_identifier}": { "get": { "tags": [ "Store Locations" ], "summary": "Get store location by external identifier", "description": "Retrieve a store location using your external identifier instead of the Nash store location ID.", "operationId": "store_locations_v1_get_store_location_by_external_id_route_external_identifier__string_external_identifier__get", "parameters": [ { "name": "externalIdentifier", "in": "path", "required": true, "schema": { "title": "Externalidentifier", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/store_locations/upsert": { "post": { "tags": [ "Store Locations" ], "summary": "Create or update store location", "description": "Create a new store location or update an existing one. Matches on external identifier or store location ID for upsert logic.", "operationId": "create_or_update_store_location_v1_store_locations_upsert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStoreLocationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/store_locations/upsert/bulk": { "post": { "tags": [ "Store Locations" ], "summary": "Upsert multiple store locations", "description": "Create or update multiple store locations in a single request. Each store location is matched by external identifier for upsert logic.", "operationId": "upsert_store_locations_v1_store_locations_upsert_bulk_post", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListStoreLocationsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/store_locations/{id}": { "get": { "tags": [ "Store Locations" ], "summary": "Get store location", "description": "Retrieve a single store location by ID, including its address, hours, capacity, and zone associations.", "operationId": "store_locations_v1_get_store_location_route__string_id__get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Store Locations" ], "summary": "Delete store location", "description": "Delete a store location by ID. Orders referencing this store location will no longer have a valid pickup point.", "operationId": "store_locations_v1_delete_store_location_route__string_id__delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Store Locations" ], "summary": "Update store location", "description": "Update an existing store location's details such as address, hours, or capacity. Only provided fields are updated.", "operationId": "store_locations_v1_update_store_location_route__string_id__patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStoreLocationInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreLocationResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/templates/upsert": { "post": { "tags": [ "Templates" ], "summary": "Upsert multiple templates", "description": "Create or update multiple delivery window or shift templates in a single request. Templates generate their instances on a recurring schedule. On update, a shift template's payload is merged: a field you omit keeps its stored value, and clearing one requires sending it explicitly as null. The external references are the exception, because they are resolved to internal ids only when supplied: sending externalStoreLocationId or externalZoneIds as null leaves the stored store location or zones unchanged.", "operationId": "upsert_templates_v1_templates_upsert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplatesInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplatesResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/vehicle": { "post": { "tags": [ "Vehicles" ], "summary": "Create a vehicle", "description": "Register a new vehicle for the organization's internal fleet with type and capacity details.", "operationId": "vehicles_v1_create_vehicle_route_vehicle_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVehicleInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/vehicles": { "get": { "tags": [ "Vehicles" ], "summary": "Get all vehicles", "description": "List all vehicles registered for the organization's internal fleet.", "operationId": "vehicles_v1_get_vehicles_route_vehicles_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/webhooks/event-types": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhook Event Types", "description": "Return the canonical Svix event type names available for this organization (e.g. `delivery.dropoff_complete`, `delivery.status_updated`). Use this to map a user's natural-language description ('the dropoff complete webhook') to the canonical name accepted by `POST /v1/webhooks/messages/replay`. When the org's endpoints subscribe to all events, the full Svix catalog is returned instead.", "operationId": "list_webhook_event_types_v1_webhooks_event_types_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventTypesResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/webhooks/messages": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhook Messages", "description": "Inspect webhooks sent to this organization's configured endpoints via Svix. Primarily intended for debugging 'did the customer receive our webhook?' questions. Every outbound webhook is tagged with the relevant entity IDs (e.g. `jb_abc123`, `dlv_xyz789`), so pass the Nash ID as `tag` to find all webhooks about that entity. Returns an empty result if the organization has no Svix app configured.", "operationId": "list_webhook_messages_v1_webhooks_messages_get", "parameters": [ { "name": "tag", "in": "query", "description": "Filter messages by tag. Nash stamps entity IDs as tags on every outbound webhook, so pass the prefixed Nash ID directly \u2014 e.g. `jb_abc123` to find every webhook about a job, `dlv_xyz789` for a delivery.", "required": false, "schema": { "title": "Tag", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter messages by tag. Nash stamps entity IDs as tags on every outbound webhook, so pass the prefixed Nash ID directly \u2014 e.g. `jb_abc123` to find every webhook about a job, `dlv_xyz789` for a delivery.", "default": null, "example": "jb_abc123" }, "example": "jb_abc123" }, { "name": "eventTypes", "in": "query", "description": "Comma-separated Svix event types (e.g. delivery.status_updated)", "required": false, "schema": { "title": "Eventtypes", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Comma-separated Svix event types (e.g. delivery.status_updated)", "default": null } }, { "name": "channel", "in": "query", "description": "Filter by Svix channel", "required": false, "schema": { "title": "Channel", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by Svix channel", "default": null } }, { "name": "before", "in": "query", "description": "Return messages sent before this timestamp", "required": false, "schema": { "title": "Before", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Return messages sent before this timestamp", "default": null } }, { "name": "after", "in": "query", "description": "Return messages sent after this timestamp", "required": false, "schema": { "title": "After", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Return messages sent after this timestamp", "default": null } }, { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "maximum": 250, "minimum": 1.0, "type": "integer", "default": 50, "example": 50 }, "example": 50 }, { "name": "iterator", "in": "query", "description": "Svix pagination cursor \u2014 pass the `iterator` from a previous response to fetch the next page", "required": false, "schema": { "title": "Iterator", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Svix pagination cursor \u2014 pass the `iterator` from a previous response to fetch the next page", "default": null } }, { "name": "withContent", "in": "query", "description": "Include the message payload in the response. Defaults to true for debugging.", "required": false, "schema": { "title": "Withcontent", "type": "boolean", "description": "Include the message payload in the response. Defaults to true for debugging.", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessagesListResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/webhooks/messages/replay": { "post": { "tags": [ "Webhooks" ], "summary": "Replay Webhook Message", "description": "Resend a Svix webhook. Two lookup modes:\n\n- `msgId`: replay a known message by its Svix ID.\n- `tag` + `eventType`: replay the most recent message matching both filters \u2014 intended for agent flows like 'resend the dropoff_complete webhook for dlv_123'. Both fields are required together so we never replay an unrelated event for the same entity (a job has many event types tagged with the same job ID).\n\n`eventType` must be the canonical Svix name (e.g. `delivery.dropoff_complete`), not a human description. Call `GET /v1/webhooks/event-types` first to map natural language to the right canonical value.\n\nBy default, the message is replayed to every endpoint it was originally attempted against. Pass `endpointId` to scope the replay to one endpoint. Per-endpoint Svix errors are surfaced in `results` rather than failing the whole call.", "operationId": "replay_webhook_message_v1_webhooks_messages_replay_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessageReplayRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessageReplayResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/webhooks/messages/{msg_id}/attempts": { "get": { "tags": [ "Webhooks" ], "summary": "List Webhook Delivery Attempts", "description": "Return the per-endpoint delivery attempt history for a single webhook message \u2014 status code, response body, timestamp, and retry attempts. Use this after locating the message via GET /v1/webhooks/messages to answer 'why didn't our webhook reach the customer?' questions.", "operationId": "list_webhook_message_attempts_v1_webhooks_messages__string_msg_id__attempts_get", "parameters": [ { "name": "msgId", "in": "path", "description": "Svix message ID", "required": true, "schema": { "title": "Msgid", "type": "string", "description": "Svix message ID" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookMessageAttemptsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/widgets/embed-credentials": { "get": { "tags": [ "Widgets" ], "summary": "List Widget Embed Credentials", "description": "The org's embed credentials. Secrets are never returned \u2014 only `last_four`.", "operationId": "widgets_v1_list_widget_embed_credentials_route_embed_credentials_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetEmbedCredentialsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Widgets" ], "summary": "Issue Widget Embed Credential", "description": "Mint a server-to-server embed credential. The plaintext `secret` is returned **once**, in this response only; it is stored as a one-way hash and cannot be retrieved again.", "operationId": "widgets_v1_issue_widget_embed_credential_route_embed_credentials_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueWidgetEmbedCredentialBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetEmbedCredentialIssued" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/widgets/embed-credentials/{id}/revoke": { "post": { "tags": [ "Widgets" ], "summary": "Revoke Widget Embed Credential", "description": "Retire a credential immediately. Revocation is one-way \u2014 there is no un-revoke.", "operationId": "widgets_v1_revoke_widget_embed_credential_route_embed_credentials__id__revoke_post", "parameters": [ { "name": "id", "in": "path", "description": "The Nash widget embed credential id (``wec_\u2026``).", "required": true, "schema": { "title": "Id", "type": "string", "description": "The Nash widget embed credential id (``wec_\u2026``)." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetEmbedCredentialRead" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/widgets/embed-credentials/{id}/rotate": { "post": { "tags": [ "Widgets" ], "summary": "Rotate Widget Embed Credential", "description": "Issue a replacement credential and retire the outgoing one. With `overlap_minutes > 0` both work until the window closes; with `0` the outgoing credential is revoked immediately.", "operationId": "widgets_v1_rotate_widget_embed_credential_route_embed_credentials__id__rotate_post", "parameters": [ { "name": "id", "in": "path", "description": "The Nash widget embed credential id (``wec_\u2026``).", "required": true, "schema": { "title": "Id", "type": "string", "description": "The Nash widget embed credential id (``wec_\u2026``)." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotateWidgetEmbedCredentialBody" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetEmbedCredentialRotation" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/widgets/entitlements/{widget}": { "get": { "tags": [ "Widgets" ], "summary": "Get Widget Entitlement", "description": "Resolved availability for one widget, folding in the Nash kill switch.", "operationId": "widgets_v1_get_widget_entitlement_route_entitlements__widget__get", "parameters": [ { "name": "widget", "in": "path", "description": "Which widget to resolve entitlement for.", "required": true, "schema": { "$ref": "#/components/schemas/WidgetKind", "description": "Which widget to resolve entitlement for." } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetEntitlement" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/widgets/settings": { "get": { "tags": [ "Widgets" ], "summary": "Get Widget Settings", "description": "The org's allowed parent origins and per-widget enablement.", "operationId": "widgets_v1_get_widget_settings_route_settings_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetSettingsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "put": { "tags": [ "Widgets" ], "summary": "Replace Widget Settings", "description": "Replace the org's widget settings. Origins are normalized to `scheme://host[:port]`; an omitted field clears it.", "operationId": "widgets_v1_set_widget_settings_route_settings_put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetSettingsWrite" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetSettingsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflow-executions/{id}": { "get": { "tags": [ "Workflow Execution" ], "summary": "Get Workflow Execution Detail", "description": "Returns a single workflow execution with all its execution steps, including step status, node references, and node variables.", "operationId": "get_workflow_execution_v1_workflow_executions__string_id__get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows": { "get": { "tags": [ "Workflow" ], "summary": "List Workflows", "description": "Returns all non-archived workflows for the authenticated organization.", "operationId": "list_workflows_v1_workflows_get", "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Workflow" ], "summary": "Create Workflow", "description": "Create a new workflow with nodes, edges, and a trigger. The workflow is created in draft status by default. Nodes define the actions and filters, edges define the execution flow between nodes, and the trigger defines when the workflow is activated. First fetch GET /workflows/schema for current action config schemas and branch rules. Bounded AI decisions use nodeType=action, nodeAction=ai_decision; a workflow may contain multiple decision nodes, each with its own config and named decision edges.", "operationId": "create_workflow_v1_workflows_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkflowInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows/schema": { "get": { "tags": [ "Workflow" ], "summary": "Get Workflow Schema", "description": "Returns self-describing workflow metadata including triggers, action config schemas, filter operators/fields, published node outputs, and supported workflow node, edge, and status types. Fetch before authoring a workflow. Action-specific edge_rules override the ordinary node-type rules. ai_decision includes all three decision modes, template syntax, availability, and test semantics.", "operationId": "get_workflow_schema_v1_workflows_schema_get", "responses": { "200": { "description": "OK" }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows/{id}": { "get": { "tags": [ "Workflow" ], "summary": "Get Workflow", "description": "Returns a single workflow by ID, including its latest version with nodes, edges, and trigger.", "operationId": "get_workflow_v1_workflows__string_id__get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Workflow" ], "summary": "Update Workflow", "description": "Update an existing workflow. Only provided fields are updated. If nodes, edges, and trigger are all provided, a new workflow version is created. These three structure fields must be provided together or not at all.", "operationId": "update_workflow_v1_workflows__string_id__patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkflowInputSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows/{id}/executions": { "get": { "tags": [ "Workflow Execution" ], "summary": "List Workflow Executions", "description": "Returns paginated workflow execution history with optional filtering by status, date range, and search. Supports sorting by created_at, completed_at, or status.", "operationId": "list_workflow_executions_v1_workflows__string_id__executions_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "title": "Offset", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 0 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "Sortby", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "sortDirection", "in": "query", "required": false, "schema": { "title": "Sortdirection", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "status", "in": "query", "required": false, "schema": { "title": "Status", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null } }, { "name": "startDate", "in": "query", "required": false, "schema": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } }, { "name": "endDate", "in": "query", "required": false, "schema": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } }, { "name": "search", "in": "query", "required": false, "schema": { "title": "Search", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows/{id}/executions/count": { "get": { "tags": [ "Workflow Execution" ], "summary": "Count Workflow Executions", "description": "Returns the total count of workflow executions matching the given filters. Useful for pagination or dashboards without fetching full execution data.", "operationId": "count_workflow_executions_v1_workflows__string_id__executions_count_get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "title": "Limit", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 50 } }, { "name": "offset", "in": "query", "required": false, "schema": { "title": "Offset", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 0 } }, { "name": "sortBy", "in": "query", "required": false, "schema": { "title": "Sortby", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "sortDirection", "in": "query", "required": false, "schema": { "title": "Sortdirection", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, { "name": "status", "in": "query", "required": false, "schema": { "title": "Status", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null } }, { "name": "startDate", "in": "query", "required": false, "schema": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } }, { "name": "endDate", "in": "query", "required": false, "schema": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } }, { "name": "search", "in": "query", "required": false, "schema": { "title": "Search", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } ], "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows/{id}/status": { "post": { "tags": [ "Workflow" ], "summary": "Set Workflow Status", "description": "Change the status of a workflow (draft, active, inactive, archived, template). Archiving a workflow disables its notification trigger.", "operationId": "set_workflow_status_v1_workflows__string_id__status_post", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWorkflowStatusSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows/{id}/test": { "post": { "tags": [ "Workflow" ], "summary": "Test Workflow", "description": "Run a workflow against a real entity without activating it. Requires jobId or orderId \u2014 the entity the run is evaluated against. By default this is a dry run: filters are evaluated against the entity and each action returns a preview of what it would do, without performing it. With live=true, messaging actions (send_slack, send_email, send_sms) are sent with a [Test] prefix and ai_decision calls the model; every other action stays preview-only and its preview carries a note saying so, so a live test can never apply a state change such as cancel_order or add_tag. Returns per-node status, so a caller can confirm which filters passed before activating the workflow.", "operationId": "test_workflow_v1_workflows__string_id__test_post", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestWorkflowSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/workflows/{id}/trigger": { "post": { "tags": [ "Workflow" ], "summary": "Trigger Workflow", "description": "Trigger an active or inactive workflow with optional entity references and input data. Supports sync and async execution modes.", "operationId": "trigger_workflow_v1_workflows__string_id__trigger_post", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerWorkflowSerializer" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zone-restrictions": { "get": { "tags": [ "Zones" ], "summary": "Get zone restrictions", "description": "List all zone restrictions for the organization. Zone restrictions define rules that control delivery behavior within specific zones.", "operationId": "get_zone_restrictions_v1_zone_restrictions_get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListZoneRestrictionsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Zones" ], "summary": "Create zone restriction", "description": "Create a zone restriction rule that controls delivery behavior within a specific zone, such as provider restrictions or time-based rules.", "operationId": "create_zone_restriction_v1_zone_restrictions_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateZoneRestrictionInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneRestrictionResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zone-restrictions/upsert": { "post": { "tags": [ "Zones" ], "summary": "Upsert multiple zone restrictions", "description": "Create or update multiple zone restrictions in a single request. Existing restrictions are matched by ID for updates.", "operationId": "upsert_zone_restrictions_v1_zone_restrictions_upsert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertZoneRestrictionsInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListZoneRestrictionsResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zone-restrictions/{id}": { "patch": { "tags": [ "Zones" ], "summary": "Update zone restriction", "description": "Update an existing zone restriction's rules or configuration. Only provided fields are updated.", "operationId": "update_zone_restriction_v1_zone_restrictions__string_id__patch", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the zone restriction.", "required": true, "schema": { "title": "Id", "type": "string", "description": "The ID of the zone restriction." } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateZoneRestrictionInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneRestrictionResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zones": { "get": { "tags": [ "Zones" ], "summary": "Get zones", "description": "List zones for the organization with pagination. Use size and offset parameters to paginate. Optionally include deleted zones with is_deleted.", "operationId": "get_zones_list_v1_zones_get", "parameters": [ { "name": "size", "in": "query", "description": "The size of the zones to return.", "required": false, "schema": { "title": "Size", "type": "integer", "description": "The size of the zones to return.", "default": 10 } }, { "name": "offset", "in": "query", "description": "The offset of the zones to return.", "required": false, "schema": { "title": "Offset", "type": "integer", "description": "The offset of the zones to return.", "default": 0 } }, { "name": "isDeleted", "in": "query", "description": "Whether to return deleted zones.", "required": false, "schema": { "title": "Isdeleted", "type": "boolean", "description": "Whether to return deleted zones.", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListZonesResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "post": { "tags": [ "Zones" ], "summary": "Create a zone", "description": "Create a geographic zone defined by a polygon boundary. Zones are used to define delivery areas for store locations and apply zone-based restrictions.", "operationId": "create_zone_v1_zones_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateZoneInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zones/coverage": { "get": { "tags": [ "Zones" ], "summary": "Get zones that cover specified location (latitude & longitude, city_zipcode)", "description": "Find zones whose polygon boundaries contain a given geographic point. Provide latitude/longitude, city_zipcode, or zipcode to find matching zones.", "operationId": "get_zones_coverage_v1_zones_coverage_get", "parameters": [ { "name": "latitude", "in": "query", "description": "The latitude of the location to check coverage for. If used, must specify longitude", "required": false, "schema": { "title": "Latitude", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The latitude of the location to check coverage for. If used, must specify longitude", "default": null, "example": "0.00" }, "example": "0.00" }, { "name": "longitude", "in": "query", "description": "The longitude of the location to check coverage for. If used, must specify latitude", "required": false, "schema": { "title": "Longitude", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The longitude of the location to check coverage for. If used, must specify latitude", "default": null, "example": "0.00" }, "example": "0.00" }, { "name": "cityZipcode", "in": "query", "description": "The city_zipcode pair to check coverage for. The location must have coverage set up using the `City & Zip Code` unique field, not the separate `City` or `Zip Code` fields.", "required": false, "schema": { "title": "Cityzipcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city_zipcode pair to check coverage for. The location must have coverage set up using the `City & Zip Code` unique field, not the separate `City` or `Zip Code` fields.", "default": null, "example": "sanfrancisco_94114" }, "example": "sanfrancisco_94114" }, { "name": "zipcode", "in": "query", "description": "The zipcode to check coverage for.", "required": false, "schema": { "title": "Zipcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zipcode to check coverage for.", "default": null, "example": "94114" }, "example": "94114" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListZonesResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zones/external_identifier/{externalIdentifier}": { "get": { "tags": [ "Zones" ], "summary": "Get zone by external identifier", "description": "Retrieve a zone using your external identifier instead of the Nash zone ID.", "operationId": "get_zone_by_external_id_v1_zones_external_identifier__string_externalIdentifier__get", "parameters": [ { "name": "externalIdentifier", "in": "path", "required": true, "schema": { "title": "Externalidentifier", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zones/query": { "post": { "tags": [ "Zones" ], "summary": "Query zones", "description": "Return full zone details for many zones in a single call. Filter by `ids` and/or `externalIds` (combined with OR); omit both to page through all of the organization's zones. Results come back under `data` with pagination under `meta`; each `data` item matches the shape of `GET /v1/zones/`.", "operationId": "zones_v1_query_zones_route_query_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZonesQueryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZonesQueryResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zones/upsert": { "post": { "tags": [ "Zones" ], "summary": "Upsert multiple zones", "description": "Create or update multiple zones in a single request. Existing zones are matched by ID or external identifier for updates.", "operationId": "upsert_zones_v1_zones_upsert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertZonesInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListZonesResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v1/zones/{id}": { "get": { "tags": [ "Zones" ], "summary": "Get zone", "description": "Retrieve a single zone by ID, including its polygon boundary and associated store locations.", "operationId": "get_zone_v1_zones__string_id__get", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "delete": { "tags": [ "Zones" ], "summary": "Delete a zone", "description": "Delete a zone by ID. Removes the zone and its store location associations.", "operationId": "delete_zone_v1_zones__string_id__delete", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } }, "patch": { "tags": [ "Zones" ], "summary": "Update a zone", "description": "Update an existing zone's name, polygon boundary, or associated store locations. Only provided fields are updated.", "operationId": "update_zone_v1_zones__string_id__patch", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "title": "Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateZoneInputSerializer" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } }, "/v2/orders/upsert/bulk": { "post": { "tags": [ "Order" ], "summary": "Create or update orders by external identifier (v2)", "description": "Create new orders or update existing ones by external identifier. Returns a `results` array \u2014 one entry per input order, in the same order as the request \u2014 each carrying a `success` or `failed` status, plus a `summary` of the counts. A hard failure on one order does not fail the batch; the rest still commit.", "operationId": "orders_v2_bulk_upsert_orders_route_upsert_bulk_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrdersInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpsertOrdersResponse" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NashValidationError" } } } } } } } } }, "components": { "schemas": { "ActionKey": { "title": "ActionKey", "enum": [ "send_message", "flag_delivery", "auto_resolve_flag", "add_custom_event" ], "type": "string", "description": "The actions a trigger can be configured to take when it fires." }, "ActivityAction": { "title": "ActivityAction", "enum": [ "act_dispatch_optimized_orders", "act_optimize_orders", "act_optimize_plan", "act_store_catalog_sync_run", "act_store_catalog_sync_file", "act_optimize_routes", "act_post_dispatch_reoptimize", "act_manifest_orders", "act_orders_bulk_operation", "act_orders_bulk_action", "act_process_csv_upload", "act_dispatch_routes", "act_dispatch_delivery_window_orders", "act_dispatch_and_manifest_batch", "act_dispatch_and_manifest_chunk", "generate_refund_ai_analysis_report", "generate_customer_feedback_report", "generate_report", "act_harness_experiment", "act_calculate_schedule" ], "type": "string" }, "ActivityStatus": { "title": "ActivityStatus", "enum": [ "QUEUED", "IN_PROGRESS", "SUCCESS", "FAILED", "CANCELLED", "SKIPPED", "SCHEDULED" ], "type": "string", "description": "Status of an activity." }, "ActivityStatusTransitionParams": { "title": "ActivityStatusTransitionParams", "required": [ "activityStatus", "activityActions" ], "type": "object", "properties": { "activityStatus": { "$ref": "#/components/schemas/ActivityStatus" }, "activityActions": { "title": "Activityactions", "type": "array", "items": { "$ref": "#/components/schemas/ActivityAction" } } } }, "AddContactToDenyListSerializer": { "title": "AddContactToDenyListSerializer", "required": [ "type", "value" ], "type": "object", "properties": { "type": { "title": "Type", "type": "string", "description": "The type of contact to add to the deny list." }, "value": { "title": "Value", "type": "string", "description": "The value of the contact to add to the deny list." } }, "description": "Expected payload for endpoint assigning role names to a user." }, "AddEventInputSerializer": { "title": "AddEventInputSerializer", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A free-form event name. Mutually exclusive with customEventDefinitionId and customEventDefinitionKey.", "default": null }, "customEventDefinitionId": { "title": "Customeventdefinitionid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of a pre-defined custom event in your org's catalog. The definition's immutable key becomes the event name. Mutually exclusive with name and customEventDefinitionKey.", "default": null }, "customEventDefinitionKey": { "title": "Customeventdefinitionkey", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The key of a pre-defined custom event in your org's catalog (the Event key shown under Orchestrate > Custom Events in the Portal). Resolves to that definition and emits the key as the event name. Mutually exclusive with name and customEventDefinitionId.", "default": null }, "timestamp": { "title": "Timestamp", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The event time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'. Defaults to now.", "default": null }, "payload": { "title": "Payload", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null } }, "description": "Expected payload for the add event endpoint.\n\nExactly one of ``name`` / ``customEventDefinitionId`` / ``customEventDefinitionKey``\nmust be supplied \u2014 none-set and more-than-one-set are rejected with\n``CUSTOM_EVENT_DEFINITION_REFERENCE_INVALID``. None can be marked required here, so\nthat rule is enforced by the service layer (``resolve_custom_event_reference``)\nrather than by this schema." }, "AddEventOutputSerializer": { "title": "AddEventOutputSerializer", "required": [ "event" ], "type": "object", "properties": { "event": { "$ref": "#/components/schemas/EventOutputPayload" } } }, "AddFeedbackInputSerializer": { "title": "AddFeedbackInputSerializer", "required": [ "score" ], "type": "object", "properties": { "score": { "title": "Score", "type": "number", "description": "Feedback score" }, "comment": { "title": "Comment", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Feedback comment", "default": null } } }, "AlternativeDropoffTimeWindow": { "title": "AlternativeDropoffTimeWindow", "required": [ "start", "end" ], "type": "object", "properties": { "start": { "title": "Start", "type": "string" }, "end": { "title": "End", "type": "string" } } }, "AssignRouteInputSerializer": { "title": "AssignRouteInputSerializer", "type": "object", "properties": { "providerId": { "title": "Providerid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider id to assign. Selects the route's successful quote for this provider.", "default": null, "example": "uber" }, "driverGroupId": { "title": "Drivergroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Driver group/Contract id (internal or external) to assign. Selects the route's successful quote for this contract.", "default": null, "example": "cntr_7mP3xVt9Nk8sRfWzY2hLbQ" }, "courierId": { "title": "Courierid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier/Driver id (internal or external) to assign to the route. The courier must belong to the route's driver group.", "default": null, "example": "cor_9dK2mNp7xVt3RfWzY8sLbQ" }, "vehicleId": { "title": "Vehicleid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vehicle id (internal or external) to assign to the route. The vehicle must be assigned to the route's driver group (contract).", "default": null, "example": "veh_4hL8pXq2sVn6RtY3wCbD9M" } }, "description": "Input for assigning or reassigning a route.\n\nProvide a provider, a driver group (contract), a courier, and/or a vehicle;\ndriver group / courier / vehicle ids may be internal or external. Pre-dispatch the assignment\nis updated in place; post-dispatch the route is reassigned (cancel live deliveries, recreate\ntasks, re-quote) and the new target applied." }, "BarcodeInfoSerializer": { "title": "BarcodeInfoSerializer", "type": "object", "properties": { "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "priceCents": { "title": "Pricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "productCode": { "title": "Productcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "isVariableWeight": { "title": "Isvariableweight", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "barcode": { "title": "Barcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "variableValue": { "title": "Variablevalue", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "format": { "title": "Format", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "indicatorDigit": { "title": "Indicatordigit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "checkDigit": { "title": "Checkdigit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "manufacturerCode": { "title": "Manufacturercode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "itemReference": { "title": "Itemreference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pluCheckDigit": { "title": "Plucheckdigit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "barcodeSansCheckDigit": { "title": "Barcodesanscheckdigit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "expirationDate": { "title": "Expirationdate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "description": "Serializer for barcode information in scans." }, "BarcodeProof": { "title": "BarcodeProof", "required": [ "podType", "value", "status" ], "type": "object", "properties": { "podType": { "title": "Podtype", "enum": [ "barcode_scan_on_pickup", "barcode_scan_on_dropoff", "barcode_scan_on_return" ], "type": "string", "description": "Type of barcode scan." }, "value": { "title": "Value", "type": "string", "description": "The scanned barcode string." }, "status": { "title": "Status", "enum": [ "success", "invalid", "failure", "skipped", "manually_entered", "damaged" ], "type": "string", "description": "Outcome of the scan." } }, "description": "Barcode scan recorded at pickup, dropoff, or during a return." }, "BasicUserSerializer": { "title": "BasicUserSerializer", "required": [ "email" ], "type": "object", "properties": { "email": { "title": "Email", "type": "string", "description": "Email", "example": "john.doe@example.com" } }, "description": "Generic serializer for basic users used in many endpoints." }, "BatchSerializer": { "title": "BatchSerializer", "required": [ "id", "type", "objectSequence", "stopTypes", "quotes" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "type": { "title": "Type", "type": "string" }, "objectSequence": { "title": "Objectsequence", "type": "array", "items": { "type": "string" } }, "stopTypes": { "title": "Stoptypes", "type": "array", "items": { "$ref": "#/components/schemas/BatchStopTypes" } }, "providerId": { "title": "Providerid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "providerIsInternal": { "title": "Providerisinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "winnerQuote": { "title": "Winnerquote", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "quotes": { "title": "Quotes", "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" } }, "failedQuotes": { "title": "Failedquotes", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": null }, "quoteFailure": { "title": "Quotefailure", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null } }, "description": "Generic serializer for batches used in many endpoints." }, "BatchStopTypes": { "title": "BatchStopTypes", "enum": [ "PICKUP", "DROPOFF", "RETURN", "DRIVER_BREAK", "ROUTE_START", "ROUTE_END" ], "type": "string", "description": "Various stop types for batch and route object." }, "BillingUsageGranularity": { "title": "BillingUsageGranularity", "enum": [ "week", "month" ], "type": "string" }, "BillingUsagePoint": { "title": "BillingUsagePoint", "required": [ "period_start", "period_end", "billable_orders", "billable_deliveries", "is_final" ], "type": "object", "properties": { "period_start": { "title": "Period Start", "type": "string", "format": "date" }, "period_end": { "title": "Period End", "type": "string", "format": "date" }, "billable_orders": { "title": "Billable Orders", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "billable_deliveries": { "title": "Billable Deliveries", "type": "integer" }, "is_final": { "title": "Is Final", "type": "boolean" } } }, "BillingUsageResponse": { "title": "BillingUsageResponse", "required": [ "granularity", "points" ], "type": "object", "properties": { "granularity": { "$ref": "#/components/schemas/BillingUsageGranularity" }, "points": { "title": "Points", "type": "array", "items": { "$ref": "#/components/schemas/BillingUsagePoint" } } } }, "BookDeliveryWindowInputSerializer": { "title": "BookDeliveryWindowInputSerializer", "required": [ "deliveryWindowId" ], "type": "object", "properties": { "deliveryWindowId": { "title": "Deliverywindowid", "type": "string", "description": "The id of the delivery window", "example": "dw_1234567890" }, "requestedCapacity": { "title": "Requestedcapacity", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The requested capacity for the delivery window.", "default": null, "example": 10.0 }, "expiresAt": { "title": "Expiresat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The time at which the booking of a delivery window expires unless confirmed. Useful for allowing customers to reserve a delivery window while they continue to build their carts.", "default": null, "example": "2024-10-07T00:00:00Z" } }, "description": "Expected payload for the book delivery window endpoint." }, "BreakChange": { "title": "BreakChange", "required": [ "break_id", "kind", "owner_vehicle_type_ids", "owned_by_retained_type", "changes" ], "type": "object", "properties": { "break_id": { "title": "Break Id", "type": "string" }, "kind": { "title": "Kind", "enum": [ "added", "removed", "changed" ], "type": "string" }, "owner_vehicle_type_ids": { "title": "Owner Vehicle Type Ids", "type": "array", "items": { "type": "string" } }, "owned_by_retained_type": { "title": "Owned By Retained Type", "type": "boolean" }, "changes": { "title": "Changes", "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } } } }, "BreakConfig": { "title": "BreakConfig", "type": "object", "properties": { "anchor": { "title": "Anchor", "anyOf": [ { "type": "string", "const": "shift_start" }, { "type": "null" } ], "default": null }, "preferOffRoute": { "title": "Preferoffroute", "type": "boolean", "description": "Prefer breaks at the store when anchor is shift_start.", "default": false } }, "additionalProperties": false }, "BreakConfiguration": { "title": "BreakConfiguration", "required": [ "breakDuration" ], "type": "object", "properties": { "timeWindow": { "title": "Timewindow", "anyOf": [ { "maxItems": 2, "minItems": 2, "type": "array", "prefixItems": [ { "type": "integer" }, { "type": "integer" } ] }, { "type": "null" } ], "description": "The time window of the break. (in minutes)", "default": null, "example": [ 0, 30 ] }, "breakDuration": { "title": "Breakduration", "type": "integer", "description": "The break duration of the break. (in minutes)", "example": 30 }, "maxWorkingTime": { "title": "Maxworkingtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The max working time of the break. (in minutes)", "default": null, "example": 30 } }, "description": "Input for creating a break configuration." }, "BulkActionStatus": { "title": "BulkActionStatus", "enum": [ "success", "error" ], "type": "string" }, "BulkDeliveryUpdateItem": { "title": "BulkDeliveryUpdateItem", "type": "object", "properties": { "status": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryStatusUpdateValue" }, { "type": "null" } ], "description": "New lifecycle status.", "default": null }, "coordinates": { "anyOf": [ { "$ref": "#/components/schemas/Coordinates" }, { "type": "null" } ], "description": "Current courier coordinates.", "default": null }, "proofOfDelivery": { "title": "Proofofdelivery", "anyOf": [ { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ImageProof" }, { "$ref": "#/components/schemas/BarcodeProof" } ], "discriminator": { "propertyName": "podType", "mapping": { "barcode_scan_on_dropoff": "#/components/schemas/BarcodeProof", "barcode_scan_on_pickup": "#/components/schemas/BarcodeProof", "barcode_scan_on_return": "#/components/schemas/BarcodeProof", "photo_pre_delivery_verification": "#/components/schemas/ImageProof", "photo_proof_of_delivery": "#/components/schemas/ImageProof", "photo_proof_of_pickup": "#/components/schemas/ImageProof", "signature_proof_of_delivery": "#/components/schemas/ImageProof", "signature_proof_of_pickup": "#/components/schemas/ImageProof" } } } }, { "type": "null" } ], "description": "Proof artifacts captured at the stop. Image or barcode, discriminated by `podType`.", "default": null }, "pickedItems": { "title": "Pickeditems", "anyOf": [ { "maxItems": 200, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/PickedItem" } }, { "type": "null" } ], "description": "Every item picked for the delivery so far. Replaces the picked items the delivery holds, so each request sends the whole list, and sending it again changes nothing. Announced by the delivery's `items_pick_update` event when the list changed. At most 64 KB as JSON.", "default": null }, "courier": { "anyOf": [ { "$ref": "#/components/schemas/Courier" }, { "type": "null" } ], "description": "Identity and vehicle of the assigned courier.", "default": null }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryFailure" }, { "type": "null" } ], "description": "Cause when the delivery enters `failed` or `canceled_by_provider`.", "default": null }, "pickupNote": { "title": "Pickupnote", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Note from the courier at pickup. E.g. 'used the side door'.", "default": null }, "dropoffNote": { "title": "Dropoffnote", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Note from the courier at dropoff. E.g. 'left with concierge'.", "default": null }, "parkingLocation": { "title": "Parkinglocation", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the courier parked at the stop. E.g. 'loading bay 4'.", "default": null }, "returnParkingLocation": { "title": "Returnparkinglocation", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the courier parked when returning the package to the pickup location.", "default": null }, "pickupEta": { "title": "Pickupeta", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Estimated pickup arrival time. ISO 8601.", "default": null }, "dropoffEta": { "title": "Dropoffeta", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Estimated dropoff arrival time. ISO 8601.", "default": null }, "externalDeliveryId": { "title": "Externaldeliveryid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider's own identifier for this delivery.", "default": null }, "deliveryId": { "title": "Deliveryid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nash delivery id. Provide this OR packageExternalIdentifier, not both.", "default": null }, "packageExternalIdentifier": { "title": "Packageexternalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your own identifier set on the package at creation. Provide this OR deliveryId, not both. Resolves the delivery server-side.", "default": null } }, "description": "One update inside a bulk PATCH /v1/deliveries call.\n\nSame field set as ``DeliveryUpdate``, keyed by **exactly one** of:\n\n- ``deliveryId`` \u2014 the Nash delivery id, or\n- ``packageExternalIdentifier`` \u2014 the id you set on the package at\n job/order creation (e.g. via the batch-job CSV upload). Lets you drive\n updates without first round-tripping Nash delivery ids." }, "BulkDeliveryUpdateRequest": { "title": "BulkDeliveryUpdateRequest", "required": [ "deliveries" ], "type": "object", "properties": { "deliveries": { "title": "Deliveries", "maxItems": 100, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BulkDeliveryUpdateItem" }, "description": "Delivery updates to apply (max 100)." } }, "description": "Top-level body for ``PATCH /v1/deliveries`` (bulk update)." }, "BulkDeliveryUpdateResponse": { "title": "BulkDeliveryUpdateResponse", "required": [ "results" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/BulkDeliveryUpdateResultItem" }, "description": "One result per request item, in order." } }, "description": "Top-level response for ``PATCH /v1/deliveries``." }, "BulkDeliveryUpdateResultItem": { "title": "BulkDeliveryUpdateResultItem", "required": [ "deliveryId", "success" ], "type": "object", "properties": { "deliveryId": { "title": "Deliveryid", "type": "string", "description": "Echoes the key the caller sent: a Nash delivery id or a packageExternalIdentifier." }, "success": { "title": "Success", "type": "boolean", "description": "Whether the update was applied." }, "errorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error code if `success` is false.", "default": null }, "errorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error detail if `success` is false.", "default": null }, "delivery": { "title": "Delivery", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Updated delivery on success.", "default": null } }, "description": "Per-item result for a bulk update.\n\nOn success, ``delivery`` carries the same shape returned under each task\nby ``GET /v1/jobs/`` (the canonical ``DeliverySerializer`` shape).\nOn failure, ``error_code`` and ``error_message`` describe why this item\nwas skipped. Other items in the same request are unaffected.\n\n``delivery_id`` echoes back the key the caller sent for this item \u2014 either\nthe Nash delivery id or the ``packageExternalIdentifier`` \u2014 so results can\nbe matched to the request items." }, "BulkOperationResponse": { "title": "BulkOperationResponse", "required": [ "id", "status" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the bulk operation", "example": "act_1234567890" }, "status": { "$ref": "#/components/schemas/ActivityStatus", "description": "The status of the bulk operation", "example": "QUEUED" } } }, "BulkOperationResult": { "title": "BulkOperationResult", "required": [ "id", "status", "action" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the order.", "example": "ord_1234567890" }, "status": { "$ref": "#/components/schemas/BulkActionStatus", "description": "The status of the bulk operation", "example": "success" }, "action": { "title": "Action", "enum": [ "create", "upsert", "update", "delete" ], "type": "string", "description": "The action of the bulk operation", "example": "create" }, "errorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The error message of the bulk operation (will be populated with error message if the operation failed)", "default": null } } }, "BulkOperationSummary": { "title": "BulkOperationSummary", "required": [ "totalOperations", "successfulOperations", "failedOperations" ], "type": "object", "properties": { "totalOperations": { "title": "Totaloperations", "type": "integer", "description": "The total number of operations in the bulk operation", "example": 5 }, "successfulOperations": { "title": "Successfuloperations", "type": "integer", "description": "The number of successful operations in the bulk operation", "example": 4 }, "failedOperations": { "title": "Failedoperations", "type": "integer", "description": "The number of failed operations in the bulk operation", "example": 1 } } }, "BulkUpsertError": { "title": "BulkUpsertError", "required": [ "code", "message" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string", "description": "Machine-readable error code (the API contract for client-side translation).", "example": "ORDER_ALREADY_DISPATCHED" }, "message": { "title": "Message", "type": "string", "description": "Human-readable description of the failure.", "example": "Order has already been dispatched and cannot be updated." } }, "description": "Error detail for a row whose status is ``failed``." }, "BulkUpsertOrderData": { "title": "BulkUpsertOrderData", "required": [ "id", "createdAt", "portalUrl", "publicTrackingUrl", "status", "tags" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The id of the order", "example": "ord_1234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "The date and time when the order was created", "format": "date-time", "example": "2023-08-29T19:17:46.264523" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the order", "default": null, "example": "1234567890" }, "externalGroupId": { "title": "Externalgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external group id of the order", "default": null, "example": "1234567890" }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null, "example": "1234567890" }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "The URL of the order in the Nash portal", "example": "https://portal.dev.usenash.com/orders/ord_1234567890" }, "publicTrackingUrl": { "title": "Publictrackingurl", "type": "string", "description": "The URL of the order in the public tracking system", "example": "https://tracking.dev.usenash.com/ord_1234567890" }, "status": { "title": "Status", "type": "string", "description": "The status of the order", "example": "needs_attention" }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The tags of the order", "example": [ "REST_API" ] }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to Nash Jobs.", "default": null, "example": { "key": "value" } }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The pickup address of the order", "default": null, "example": "185 University Ave, Palo Alto, CA 94301" }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "185" }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "University Ave" }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null, "example": "Palo Alto" }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null, "example": "Santa Clara" }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null, "example": "CA" }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null, "example": "94301" }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null, "example": "US" }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null, "example": 37.422222 }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null, "example": -122.139776 }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null, "example": "+15555555555" }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null, "example": "store@example.com" }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin.", "default": null, "example": "Store ABC" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup.", "default": null, "example": "Leave at the front door" }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null, "example": "stl_VwpoPJaaqWiPGnXEhWfX" }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null, "example": "0021112" }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null, "example": [ "1234567890", "0987654321" ] }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null, "example": { "barcode": { "type": "CODE128", "value": "1234567890" }, "providerCard": false } }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dropoff address of the order", "default": null, "example": "401 San Antonio Rd, Mountain View, CA 94040" }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "401" }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "San Antonio Rd" }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null, "example": "Mountain View" }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null, "example": "Santa Clara" }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null, "example": "CA" }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null, "example": "94040" }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null, "example": "US" }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null, "example": 37.422222 }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null, "example": -122.139776 }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null, "example": "+15555555556" }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null, "example": "customer@example.com" }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination.", "default": null, "example": "Quote" }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination.", "default": null, "example": "Request" }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff business name at the destination.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff.", "default": null, "example": "Leave at the front door" }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the dropoff waypoint.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The delivery mode of the order", "default": null, "example": "scheduled" }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the order", "default": null, "example": "Order description" }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number of items in the order", "default": null, "example": "1" }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The requirements of the order", "default": null, "example": [ "photo_proof_of_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency of the order", "default": null, "example": "USD" }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The value of the order in cents", "default": null, "example": "10000" }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The tip amount of the order in cents", "default": null, "example": "1000" }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Null when not specified.", "default": null, "example": "10000" }, "width": { "title": "Width", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The width of the order in cm", "default": null, "example": "100" }, "depth": { "title": "Depth", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The depth of the order in cm", "default": null, "example": "100" }, "height": { "title": "Height", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The height of the order in cm", "default": null, "example": "100" }, "volume": { "title": "Volume", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The volume of the order in cm^3", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The weight of the order in kg", "default": null, "example": "100" }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "The items of the order", "default": null }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order. Note: It is the best practice to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null, "example": "dss_1234567890" }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The max delivery fee of the order in cents", "default": null, "example": "1000" }, "documents": { "title": "Documents", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrderDocumentOutput" } }, { "type": "null" } ], "description": "The documents of the order", "default": null, "example": [ { "contentType": "application/pdf", "data": "SGVsbG8gd29ybGQ=", "id": "doc_1234567890", "type": "shipping_label", "url": "https://example.com/document.pdf" } ] }, "validationErrors": { "title": "Validationerrors", "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The validation errors of the order", "default": null, "example": { "pickupStartTime": "Time is in the past" } }, "quotes": { "title": "Quotes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" } }, { "type": "null" } ], "description": "The quotes of the order", "default": null, "example": [ { "costSplitBusinessCents": null, "costSplitCustomerCents": null, "createdTime": "2024-09-03T20:43:45.899094", "currency": "USD", "dropoffEta": "2024-09-03T22:20:47.569000", "expireTime": "2024-09-03T21:43:45.899102", "id": "qot_2oWASjGxMtucwGgu6A7BYC", "insuranceFeeCents": 0, "nashFeeCents": 300, "pickupWindow": null, "priceCents": 100, "providerId": "dispatch_partner", "providerIsInternal": false, "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg", "providerName": "Dispatch", "tags": null, "taxAmountCents": null, "tollFeeCents": 0, "totalPriceBreakdown": { "priceCents": 100 }, "totalPriceCents": 100, "type": "LOCAL" } ] }, "failedQuotes": { "title": "Failedquotes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The failed quotes of the order", "default": null, "example": [ "quote_1234567890", "quote_0987654321" ] }, "quoteFailure": { "title": "Quotefailure", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Summary when every provider rejects the package requirements", "default": null } }, "description": "The full upserted order returned in a successful v2 bulk-upsert result.\n\nSubclasses `OrderOutputExample` only to enable serialising directly from the\n`Order` ORM instance via `model_validate(order)`, mirroring\n`nash.schemas.delivery_window.DeliveryWindowResponse`:\n\n- `from_attributes` \u2014 read fields straight off the ORM object.\n- `coerce_numbers_to_str` \u2014 several columns are stored as `int` on the ORM but\n declared as `str` on the response shape (e.g. `items_count`, `value_cents`);\n the legacy GraphQL path stringified these via Graphene resolvers.\n\nThe base schema itself is untouched, so v1's documented shape is unchanged." }, "BulkUpsertOrdersResponse": { "title": "BulkUpsertOrdersResponse", "required": [ "results", "summary" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpsertResult_BulkUpsertOrderData_" }, "description": "One entry per input row, in the same order as the request." }, "summary": { "$ref": "#/components/schemas/BulkUpsertSummary", "description": "Aggregate counts of each outcome." } }, "description": "Response for `POST /v2/orders/upsert/bulk`.\n\nThe orders specialisation of the generic `BulkUpsertResponse` envelope: `data` on each result\nis a full `BulkUpsertOrderData` (the upserted order). The `{results, summary}` shape and the\n`success`/`failed` per-row status come from the generic base in `server.serializers.bulk`." }, "BulkUpsertResult_BulkUpsertOrderData_": { "title": "BulkUpsertResult[BulkUpsertOrderData]", "required": [ "status" ], "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The row's external identifier, echoed back to correlate results with the request.", "default": null, "example": "1234567890" }, "status": { "$ref": "#/components/schemas/BulkUpsertStatus", "description": "Outcome for this row.", "example": "success" }, "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The upserted object's Nash id. Null when the row failed.", "default": null, "example": "ord_1234567890" }, "data": { "anyOf": [ { "$ref": "#/components/schemas/BulkUpsertOrderData" }, { "type": "null" } ], "description": "The full upserted object. Present on success, null when the row failed.", "default": null }, "errors": { "title": "Errors", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpsertError" } }, { "type": "null" } ], "description": "Failure details. Populated only when status is `failed`, null otherwise.", "default": null } } }, "BulkUpsertStatus": { "title": "BulkUpsertStatus", "enum": [ "success", "failed" ], "type": "string", "description": "Per-row outcome of a bulk upsert.\n\n``success`` means the row was upserted (created or updated). ``failed`` is reserved for hard\nerrors (a precondition violation, lock contention, a missing required field, an unexpected\nerror). Soft/validation issues that still persist the row are *not* failures \u2014 surface those on\nthe returned object, not here." }, "BulkUpsertSummary": { "title": "BulkUpsertSummary", "required": [ "success", "failed" ], "type": "object", "properties": { "success": { "title": "Success", "type": "integer", "description": "Number of rows upserted successfully.", "example": 2 }, "failed": { "title": "Failed", "type": "integer", "description": "Number of rows that failed.", "example": 1 } }, "description": "Counts of each outcome across the batch." }, "CadenceTierInputSerializer": { "title": "CadenceTierInputSerializer", "required": [ "intervalMinutes" ], "type": "object", "properties": { "maxHours": { "title": "Maxhours", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "intervalMinutes": { "title": "Intervalminutes", "type": "integer" } } }, "CalculateRouteTimingResponseSerializer": { "title": "CalculateRouteTimingResponseSerializer", "required": [ "route" ], "type": "object", "properties": { "route": { "$ref": "#/components/schemas/RouteSerializer", "description": "The route with updated per-stop ETAs and timing." }, "mappedRoutesPolyline": { "title": "Mappedroutespolyline", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "Polyline data in the same format as optimization activity results.", "default": null } }, "description": "Response for route timing calculation." }, "CalculateScheduleRequest": { "title": "CalculateScheduleRequest", "required": [ "plan_from" ], "type": "object", "properties": { "plan_from": { "title": "Plan From", "type": "string", "format": "date" }, "days": { "title": "Days", "maximum": 7, "minimum": 1.0, "type": "integer", "default": 2 }, "commit_days": { "title": "Commit Days", "maximum": 7, "minimum": 0.0, "type": "integer", "default": 1 }, "now": { "title": "Now", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "tags": { "title": "Tags", "maxItems": 20, "type": "array", "items": { "type": "string" } }, "params": { "$ref": "#/components/schemas/DspParams" }, "fallbacks": { "title": "Fallbacks", "maxItems": 10, "type": "array", "items": { "$ref": "#/components/schemas/Fallback" } }, "driver_clocks": { "title": "Driver Clocks", "maxItems": 1000, "type": "array", "items": { "$ref": "#/components/schemas/DriverClocks" } } }, "additionalProperties": false }, "CalculateScheduleResponse": { "title": "CalculateScheduleResponse", "required": [ "activity_id" ], "type": "object", "properties": { "activity_id": { "title": "Activity Id", "type": "string" } } }, "CancelOptimizationActivitiesRequest": { "title": "CancelOptimizationActivitiesRequest", "required": [ "activity_ids" ], "type": "object", "properties": { "activity_ids": { "title": "Activity Ids", "type": "array", "items": { "type": "string" } } } }, "CancelOptimizationActivitiesResponse": { "title": "CancelOptimizationActivitiesResponse", "required": [ "results" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/OptimizationCancellationOutcome" } } } }, "CancelledActivityRead": { "title": "CancelledActivityRead", "required": [ "id", "status" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "status": { "$ref": "#/components/schemas/ActivityStatus" }, "result": { "title": "Result", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": null } }, "description": "The cancelled activity as a poller reads it: status plus the `result` now carrying\n`cancellation`." }, "CauseMatch": { "title": "CauseMatch", "required": [ "cause", "order_ids", "summary" ], "type": "object", "properties": { "cause": { "$ref": "#/components/schemas/UnassignedCause" }, "order_ids": { "title": "Order Ids", "type": "array", "items": { "type": "string" } }, "summary": { "title": "Summary", "type": "string" } } }, "ChangeDirection": { "title": "ChangeDirection", "enum": [ "tightened", "loosened", "not_assessed" ], "type": "string" }, "ComparisonOutcome": { "title": "ComparisonOutcome", "enum": [ "compared", "no_dropped_orders", "no_previous_run", "input_missing" ], "type": "string" }, "CompressedAdvancedTaskSerializer": { "title": "CompressedAdvancedTaskSerializer", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Task ID", "example": "tsk_01234567890" } }, "description": "Generic serializer for tasks used in many endpoints." }, "ConditionOperator": { "title": "ConditionOperator", "enum": [ "equals", "not_equals", "greater_than", "less_than", "greater_than_or_equal_to", "less_than_or_equal_to", "in", "not_in", "contains", "starts_with", "ends_with" ], "type": "string", "description": "Operators available in a metadata condition tree.\n\nMust mirror the operators the runtime evaluator honors in\n``streaming_service/notifications/utils.py`` (meets_conditional_filter_rules);\nthe drift guard in the serializer tests locks this to the assembly dict, which\nis verified against that evaluator." }, "ConfigurationDiff": { "title": "ConfigurationDiff", "required": [ "solver_parameters", "units", "start_depots", "end_depots", "route_restrictions", "user_tags_added", "user_tags_removed", "time_anchor_changed", "other_keys", "previous_solver", "current_solver" ], "type": "object", "properties": { "solver_parameters": { "title": "Solver Parameters", "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } }, "units": { "title": "Units", "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } }, "start_depots": { "title": "Start Depots", "type": "array", "items": { "$ref": "#/components/schemas/KeyedChange" } }, "end_depots": { "title": "End Depots", "type": "array", "items": { "$ref": "#/components/schemas/KeyedChange" } }, "route_restrictions": { "title": "Route Restrictions", "type": "array", "items": { "$ref": "#/components/schemas/KeyedChange" } }, "user_tags_added": { "title": "User Tags Added", "type": "array", "items": { "type": "string" } }, "user_tags_removed": { "title": "User Tags Removed", "type": "array", "items": { "type": "string" } }, "time_anchor_changed": { "title": "Time Anchor Changed", "type": "boolean" }, "other_keys": { "title": "Other Keys", "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } }, "previous_solver": { "title": "Previous Solver", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "current_solver": { "title": "Current Solver", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ContractOverrideParametersSerializer": { "title": "ContractOverrideParametersSerializer", "required": [ "contractId" ], "type": "object", "properties": { "contractId": { "title": "Contractid", "type": "string" }, "vehicleCount": { "title": "Vehiclecount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "leadTimeMinutes": { "title": "Leadtimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "fixedCost": { "title": "Fixedcost", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "maxOrdersPerRoute": { "title": "Maxordersperroute", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "minOrdersPerRoute": { "title": "Minordersperroute", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "useAllVehicles": { "title": "Useallvehicles", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null } } }, "ContractReadDetailed": { "title": "ContractReadDetailed", "required": [ "contract_id", "first_version_contract_id", "display_name", "is_active", "currency", "provider_id", "created_at" ], "type": "object", "properties": { "contract_id": { "title": "Contract Id", "type": "string" }, "first_version_contract_id": { "title": "First Version Contract Id", "type": "string" }, "next_version_contract_id": { "title": "Next Version Contract Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "version": { "title": "Version", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "display_name": { "title": "Display Name", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "currency": { "title": "Currency", "type": "string" }, "provider_id": { "title": "Provider Id", "type": "string" }, "cancellation_binding_mode": { "title": "Cancellation Binding Mode", "anyOf": [ { "enum": [ "pinned", "disabled" ], "type": "string" }, { "type": "null" } ], "default": null }, "cancellation_policy_version_id": { "title": "Cancellation Policy Version Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "provider_name": { "title": "Provider Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "external_identifier": { "title": "External Identifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" }, "delivery_price_type": { "title": "Delivery Price Type", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "delivery_price": { "title": "Delivery Price", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "eligibility_criteria": { "title": "Eligibility Criteria", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "wait_fee": { "title": "Wait Fee", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "cancellation_fee": { "title": "Cancellation Fee", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "return_fee": { "title": "Return Fee", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "insurance_price": { "title": "Insurance Price", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "tip_amount": { "title": "Tip Amount", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "toll_fee": { "title": "Toll Fee", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "properties": { "title": "Properties", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "has_enabled_vehicles": { "title": "Has Enabled Vehicles", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether an enabled vehicle's first_version_contract_ids contains this contract's stored first_version_contract_id, matching the optimizer's Contract.vehicles relation. Computed from vehicle membership, independent of properties and vehicle ownership; null in summary mode.", "default": null }, "supported_orgs": { "title": "Supported Orgs", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "excluded_orgs": { "title": "Excluded Orgs", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "prev_version_contract_id": { "title": "Prev Version Contract Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "commit_message": { "title": "Commit Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "created_by": { "title": "Created By", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "delivery_price_function": { "title": "Delivery Price Function", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "unassigned_driver_timeout_minutes": { "title": "Unassigned Driver Timeout Minutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null } }, "description": "Full payload \u2014 populated when the caller asks for ``include=details``." }, "Coordinates": { "title": "Coordinates", "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "title": "Latitude", "maximum": 90.0, "minimum": -90.0, "type": "number", "description": "Latitude in decimal degrees." }, "longitude": { "title": "Longitude", "maximum": 180.0, "minimum": -180.0, "type": "number", "description": "Longitude in decimal degrees." } }, "description": "Latitude / longitude pair for the courier's current location." }, "Courier": { "title": "Courier", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier's display name.", "default": null }, "phoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier's phone number, E.164.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Proxy phone for the pickup contact, if issued.", "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Proxy phone for the customer, if issued.", "default": null }, "profileImageUrl": { "title": "Profileimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the courier's profile image.", "default": null }, "vehicle": { "anyOf": [ { "$ref": "#/components/schemas/CourierVehicle" }, { "type": "null" } ], "description": "Vehicle the courier is using.", "default": null }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider's own courier identifier.", "default": null } }, "description": "Identity and vehicle for the courier currently handling the delivery.\n\nSend the full block when a courier is first assigned, or any subset when\none of the fields changes (e.g., a driver swap mid-flight)." }, "CourierPositionSerializer": { "title": "CourierPositionSerializer", "required": [ "lat", "lng" ], "type": "object", "properties": { "lat": { "title": "Lat", "type": "number", "description": "Latitude coordinate." }, "lng": { "title": "Lng", "type": "number", "description": "Longitude coordinate." }, "updatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the position was last updated on the server.", "default": null }, "capturedAt": { "title": "Capturedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the GPS position was captured on driver's device.", "default": null }, "accuracy": { "title": "Accuracy", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Estimated horizontal accuracy radius in meters.", "default": null }, "heading": { "title": "Heading", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Heading in degrees relative to true north.", "default": null }, "speed": { "title": "Speed", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Speed in meters per second.", "default": null }, "altitude": { "title": "Altitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Altitude in meters above sea level.", "default": null }, "altitudeAccuracy": { "title": "Altitudeaccuracy", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Estimated altitude accuracy in meters.", "default": null }, "batteryLevel": { "title": "Batterylevel", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Battery level from 0.0 to 1.0, if provided by device.", "default": null }, "batteryIsCharging": { "title": "Batteryischarging", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the device is currently charging.", "default": null }, "isMoving": { "title": "Ismoving", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the device is currently detected as moving.", "default": null } }, "description": "Current GPS position of a courier." }, "CourierResponse": { "title": "CourierResponse", "required": [ "id", "externalidentifier", "firstname", "lastname", "phonenumber", "createdat", "firstversioncontractids", "vehicleinfo", "courierlocation", "vehicleids" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the courier." }, "externalidentifier": { "title": "Externalidentifier", "type": "string", "description": "The external identifier of the courier." }, "firstname": { "title": "Firstname", "type": "string", "description": "The first name of the courier." }, "lastname": { "title": "Lastname", "type": "string", "description": "The last name of the courier." }, "phonenumber": { "title": "Phonenumber", "type": "string", "description": "The phone number of the courier." }, "createdat": { "title": "Createdat", "type": "string", "description": "The creation timestamp of the courier." }, "firstversioncontractids": { "title": "Firstversioncontractids", "type": "array", "items": { "type": "string" }, "description": "The first version contract IDs of the courier." }, "vehicleinfo": { "$ref": "#/components/schemas/VehicleInfo", "description": "The vehicle info of the courier." }, "courierlocation": { "$ref": "#/components/schemas/VehicleLocation", "description": "The location of the courier." }, "dateofbirth": { "title": "Dateofbirth", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "The date of birth of the courier.", "default": null }, "workrelationship": { "anyOf": [ { "$ref": "#/components/schemas/WorkRelationship" }, { "type": "null" } ], "description": "The work relationship type of the courier.", "default": null }, "driverslicense": { "title": "Driverslicense", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The driver's license number of the courier.", "default": null }, "vehicleids": { "title": "Vehicleids", "type": "array", "items": { "type": "string" }, "description": "The vehicles of the courier." } }, "description": "Response for courier." }, "CourierSerializer": { "title": "CourierSerializer", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "phoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "description": "Courier details for a route." }, "CourierUpsert": { "title": "CourierUpsert", "required": [ "externalIdentifier", "phoneNumber" ], "type": "object", "properties": { "externalIdentifier": { "title": "Externalidentifier", "type": "string", "description": "Caller's own id for this driver; the upsert identity key." }, "phoneNumber": { "title": "Phonenumber", "minLength": 1, "type": "string", "description": "Required. Links or creates the driver's Nash User record, attaches the driver role, and provisions SMS login. Supply an international number with a leading country code; the value is stored in E.164 form. Does not send a welcome message." }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optionally provisions a Nash driver-app email login on the phone-linked User, mirroring the portal's own driver create/edit behavior. Omit, null, or blank leaves the existing email unchanged.", "default": null }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "vehicleInfo": { "title": "Vehicleinfo", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "vehicleIds": { "title": "Vehicleids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Existing Vehicle ids to link to this driver.", "default": null }, "storeLocationIds": { "title": "Storelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "firstVersionContractIds": { "title": "Firstversioncontractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Full driver group membership, by first_version_contract_id. Omit or null to leave unchanged. Cannot be combined with addFirstVersionContractIds / removeFirstVersionContractIds.", "default": null }, "addFirstVersionContractIds": { "title": "Addfirstversioncontractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Driver groups to add this driver to; other memberships are kept.", "default": null }, "removeFirstVersionContractIds": { "title": "Removefirstversioncontractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Driver groups to remove this driver from; other memberships are kept.", "default": null }, "isShiftActive": { "title": "Isshiftactive", "type": "boolean", "description": "Whether the driver is available. Defaults to true for a newly created driver when omitted; an update call that omits it leaves the existing value unchanged.", "default": true }, "enabled": { "title": "Enabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "dateOfBirth": { "title": "Dateofbirth", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "default": null }, "workRelationship": { "anyOf": [ { "$ref": "#/components/schemas/WorkRelationship" }, { "type": "null" } ], "default": null }, "driversLicense": { "title": "Driverslicense", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "additionalProperties": false, "description": "``PUT /v1/fleet/drivers/upsert`` request body \u2014 see FLE-2224.\n\nUpsert identity is ``external_identifier``, scoped to the calling org's own\ninternal-fleet provider. The required phone links a ``User`` who already belongs to the\ncalling organization or creates a new one, so portal roster queries include the driver. A\nphone owned outside the organization is rejected. The endpoint attaches the organization's\ndriver role and provisions an Auth0 passwordless SMS identity. An optional email provisions\nthe Auth0 email identity on that user.\n\nWire format is camelCase, matching the rest of Nash's customer-facing REST\nAPI (``populate_by_name=True`` also accepts snake_case)." }, "CourierVehicle": { "title": "CourierVehicle", "type": "object", "properties": { "make": { "title": "Make", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vehicle make. E.g. 'Toyota'.", "default": null }, "model": { "title": "Model", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vehicle model. E.g. 'Prius'.", "default": null }, "color": { "title": "Color", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vehicle color. E.g. 'white'.", "default": null }, "licensePlate": { "title": "Licenseplate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "License plate.", "default": null } }, "description": "Vehicle the courier is using to fulfill the delivery." }, "CreateActivityStatusTransitionTrigger": { "title": "CreateActivityStatusTransitionTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "activity_status_transition" }, "parameters": { "$ref": "#/components/schemas/ActivityStatusTransitionParams" } } }, "CreateAddressValidationFailedTrigger": { "title": "CreateAddressValidationFailedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "address_validation_failed" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateAiConversationCompletedTrigger": { "title": "CreateAiConversationCompletedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "ai_conversation_completed" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateApiBasedTrigger": { "title": "CreateApiBasedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "api_based" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateAutodispatchFailedTrigger": { "title": "CreateAutodispatchFailedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "autodispatch_failed" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateBatchJobInputSerializer": { "title": "CreateBatchJobInputSerializer", "required": [ "packages" ], "type": "object", "properties": { "packages": { "title": "Packages", "type": "array", "items": { "$ref": "#/components/schemas/PackageSchemaMixin" } }, "jobMetadata": { "title": "Jobmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "optionsGroupId": { "title": "Optionsgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "inputDatetimesLocalizedToPickupTz": { "title": "Inputdatetimeslocalizedtopickuptz", "type": "boolean", "default": false } }, "description": "Expected input for creating a batch job." }, "CreateConversationAssignedTrigger": { "title": "CreateConversationAssignedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "conversation_assigned" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateConversationHandlerChangedTrigger": { "title": "CreateConversationHandlerChangedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "conversation_handler_changed" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateConversationMessageReceivedTrigger": { "title": "CreateConversationMessageReceivedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "conversation_message_received" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateConversationReopenedTrigger": { "title": "CreateConversationReopenedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "conversation_reopened" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateConversationResolvedTrigger": { "title": "CreateConversationResolvedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "conversation_resolved" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateCourierInputSerializer": { "title": "CreateCourierInputSerializer", "required": [ "firstname", "lastname", "phonenumber" ], "type": "object", "properties": { "externalidentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier of the courier.", "default": null, "example": "courier_ext_1" }, "firstname": { "title": "Firstname", "type": "string", "description": "The first name of the courier.", "example": "John" }, "lastname": { "title": "Lastname", "type": "string", "description": "The last name of the courier.", "example": "Doe" }, "phonenumber": { "title": "Phonenumber", "type": "string", "description": "The phone number of the courier.", "example": "+1234567890" }, "vehicleinfo": { "anyOf": [ { "$ref": "#/components/schemas/VehicleInfo" }, { "type": "null" } ], "description": "The vehicle info of the courier.", "default": null, "example": { "color": "Red", "licensePlate": "ABC123", "make": "Toyota", "model": "Camry", "type": "car", "year": "2020" } }, "dateofbirth": { "title": "Dateofbirth", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "description": "The date of birth of the courier.", "default": null, "example": "1990-01-15" }, "workrelationship": { "anyOf": [ { "$ref": "#/components/schemas/WorkRelationship" }, { "type": "null" } ], "description": "The work relationship type of the courier.", "default": null, "example": "EMPLOYEE" }, "driverslicense": { "title": "Driverslicense", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The driver's license number of the courier.", "default": null, "example": "DL123456" }, "vehicleids": { "title": "Vehicleids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The vehicles of the courier.", "default": null, "example": [ "veh_1", "veh_2" ] } }, "description": "Input for creating a courier." }, "CreateCourierUpdatedTrigger": { "title": "CreateCourierUpdatedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "courier_updated" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateCustomEventListenerTrigger": { "title": "CreateCustomEventListenerTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "custom_event_listener" }, "parameters": { "$ref": "#/components/schemas/CustomEventListenerParams" } } }, "CreateDeliveryCancellationFailedTrigger": { "title": "CreateDeliveryCancellationFailedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "delivery_cancellation_failed" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateDeliveryCompletedTooEarlyTrigger": { "title": "CreateDeliveryCompletedTooEarlyTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "delivery_completed_too_early" }, "parameters": { "$ref": "#/components/schemas/DeliveryCompletedTooEarlyParams" } } }, "CreateDeliveryIncidentReportTrigger": { "title": "CreateDeliveryIncidentReportTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "delivery_incident_report" }, "parameters": { "$ref": "#/components/schemas/DeliveryIncidentReportParams" } } }, "CreateDeliveryStatusTransitionTrigger": { "title": "CreateDeliveryStatusTransitionTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "delivery_status_transition" }, "parameters": { "$ref": "#/components/schemas/DeliveryStatusTransitionParams" } } }, "CreateDeliveryWindowBookedTimeoutTrigger": { "title": "CreateDeliveryWindowBookedTimeoutTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "delivery_window_booked_timeout" }, "parameters": { "$ref": "#/components/schemas/DeliveryWindowBookedTimeoutParams" } } }, "CreateDeliveryWindowInputSerializer": { "title": "CreateDeliveryWindowInputSerializer", "type": "object", "properties": { "startTime": { "title": "Starttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The start time of the delivery window.", "default": null, "example": "2024-01-01T10:00:00Z" }, "startTimeLocal": { "title": "Starttimelocal", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The start time of the delivery window in local timezone.", "default": null, "example": "2024-01-01T10:00:00" }, "endTime": { "title": "Endtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The end time of the delivery window.", "default": null, "example": "2024-01-01T12:00:00Z" }, "endTimeLocal": { "title": "Endtimelocal", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The end time of the delivery window in local timezone.", "default": null, "example": "2024-01-01T12:00:00" }, "cutoffTime": { "title": "Cutofftime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The cutoff time of the delivery window.", "default": null, "example": "2024-01-01T10:00:00Z" }, "cutoffTimeLocal": { "title": "Cutofftimelocal", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The cutoff time of the delivery window in local timezone.", "default": null, "example": "2024-01-01T10:00:00" }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The timezone id of the delivery window.", "default": null, "example": "America/New_York" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the delivery window.", "default": null, "example": "Monday Delivery Window" }, "rrule": { "title": "Rrule", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The rrule of the delivery window.", "default": null, "example": "RRULE:FREQ=WEEKLY;BYDAY=MO" }, "exceptionDates": { "title": "Exceptiondates", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The exception dates of the delivery window.", "default": null, "example": [ "2024-01-01", "2024-01-02" ] }, "allowedTags": { "title": "Allowedtags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The allowed tags of the delivery window.", "default": null, "example": [ "service:rapid", "service:express", "franchise_location" ] }, "leadTimeMinutes": { "title": "Leadtimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The lead time of the delivery window.", "default": null, "example": 60 }, "priceCents": { "title": "Pricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price of the delivery window.", "default": null, "example": 1000 }, "minimumOrderValueCents": { "title": "Minimumordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The minimum order value of the delivery window.", "default": null, "example": 1000 }, "maximumCapacity": { "title": "Maximumcapacity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum capacity of the delivery window.", "default": null, "example": 1000 }, "storeLocationId": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The store location id of the delivery window.", "default": null, "example": "stl_01234567890123456789" }, "zoneId": { "title": "Zoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zone id of the delivery window.", "default": null, "example": "zone_01234567890123456789" }, "zoneExternalId": { "title": "Zoneexternalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external zone id of the delivery window.", "default": null, "example": "ext_01234567890123456789" }, "windowMetadata": { "title": "Windowmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the delivery window.", "default": null, "example": { "key": "value" } }, "isActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the delivery window is active.", "default": null, "example": true }, "isDeleted": { "title": "Isdeleted", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the delivery window is deleted.", "default": null, "example": false } }, "description": "Expected payload for creating a delivery window." }, "CreateDeliveryWindowsInputSerializer": { "title": "CreateDeliveryWindowsInputSerializer", "required": [ "deliveryWindows" ], "type": "object", "properties": { "deliveryWindows": { "title": "Deliverywindows", "type": "array", "items": { "$ref": "#/components/schemas/CreateDeliveryWindowInputSerializer" } } }, "description": "Expected payload for creating multiple delivery windows." }, "CreateDemoTrigger": { "title": "CreateDemoTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "demo" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateDispatchPlanFromRoutesRequest": { "title": "CreateDispatchPlanFromRoutesRequest", "required": [ "name", "routeIds" ], "type": "object", "properties": { "startDate": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "default": null }, "endDate": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "default": null }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null }, "zoneIds": { "title": "Zoneids", "type": "array", "items": { "minLength": 1, "type": "string" } }, "name": { "title": "Name", "minLength": 1, "type": "string" }, "tags": { "title": "Tags", "type": "array", "items": { "maxLength": 64, "minLength": 1, "type": "string" } }, "routeIds": { "title": "Routeids", "type": "array", "items": { "minLength": 1, "type": "string" } } }, "additionalProperties": false }, "CreateDispatchPlanRequest": { "title": "CreateDispatchPlanRequest", "required": [ "name" ], "type": "object", "properties": { "startDate": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "default": null }, "endDate": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "default": null }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null }, "zoneIds": { "title": "Zoneids", "type": "array", "items": { "minLength": 1, "type": "string" } }, "name": { "title": "Name", "minLength": 1, "type": "string" }, "tags": { "title": "Tags", "type": "array", "items": { "maxLength": 64, "minLength": 1, "type": "string" } }, "source": { "title": "Source", "enum": [ "orders", "snapshot" ], "type": "string", "default": "orders" }, "orderIds": { "title": "Orderids", "type": "array", "items": { "minLength": 1, "type": "string" } }, "routeIds": { "title": "Routeids", "type": "array", "items": { "minLength": 1, "type": "string" } } }, "additionalProperties": false }, "CreateDriverGeolocationTrigger": { "title": "CreateDriverGeolocationTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "driver_geolocation" }, "parameters": { "title": "Parameters", "oneOf": [ { "$ref": "#/components/schemas/DriverGeolocationWithinParams" }, { "$ref": "#/components/schemas/DriverGeolocationGreaterThanParams" }, { "$ref": "#/components/schemas/DriverGeolocationStoppedForParams" } ], "discriminator": { "propertyName": "condition", "mapping": { "greater_than": "#/components/schemas/DriverGeolocationGreaterThanParams", "stopped_for": "#/components/schemas/DriverGeolocationStoppedForParams", "within": "#/components/schemas/DriverGeolocationWithinParams" } } } } }, "CreateDriverLocationVsDeliveryStatusTrigger": { "title": "CreateDriverLocationVsDeliveryStatusTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "driver_location_vs_delivery_status" }, "parameters": { "$ref": "#/components/schemas/DriverLocationVsDeliveryStatusParams" } } }, "CreateDriverStackingTrigger": { "title": "CreateDriverStackingTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "driver_stacking" }, "parameters": { "$ref": "#/components/schemas/DriverStackingParams" } } }, "CreateDropoffDelayedTrigger": { "title": "CreateDropoffDelayedTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "dropoff_delayed" }, "parameters": { "$ref": "#/components/schemas/DropoffDelayedParams" } } }, "CreateFlagInputSerializer": { "title": "CreateFlagInputSerializer", "required": [ "notes" ], "type": "object", "properties": { "jobId": { "title": "Jobid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The job ID to create a flag for.", "default": null }, "taskId": { "title": "Taskid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The task ID to create a flag for.", "default": null }, "orderId": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The order ID to create a flag for.", "default": null }, "deliveryId": { "title": "Deliveryid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The delivery ID to create a flag for.", "default": null }, "status": { "$ref": "#/components/schemas/FlagStatus", "description": "The status of the flag.", "default": "NEEDS_ATTENTION" }, "notes": { "title": "Notes", "type": "string", "description": "The notes to create a flag for." } }, "description": "Expected payload for the create flag endpoint." }, "CreateInternalDriverNotAssignedTrigger": { "title": "CreateInternalDriverNotAssignedTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "internal_driver_not_assigned" }, "parameters": { "$ref": "#/components/schemas/InternalDriverNotAssignedParams" } } }, "CreateJobCreationFailedTrigger": { "title": "CreateJobCreationFailedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "job_creation_failed" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateJobInputSerializer": { "title": "CreateJobInputSerializer", "required": [ "packageDeliveryMode" ], "type": "object", "properties": { "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code], [country]. All address fields are required except \"second line\". Second line should include Apt/Suite/Unit/# appended to the number of the unit.", "default": null }, "pickupAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "pickupLatitude": { "title": "Pickuplatitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "pickupLongitude": { "title": "Pickuplongitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass \"Manager\". Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass \"Manager\". Limited to 80 characters.", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Google place ID for the pickup location.If passed, resolving the pickup location's lat/lng will happen with this field.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Nash store location ID for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the location in the form: \"+15555555555\"", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state], [zip code], [country]. All address fields are required except \"second line\". Second line should include Apt/Suite/Unit/# appended to the number of the unit.", "default": null }, "dropoffAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "dropoffLatitude": { "title": "Dropofflatitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "dropoffLongitude": { "title": "Dropofflongitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffExternalStoreLocationId": { "title": "Dropoffexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "packageDeliveryMode": { "title": "Packagedeliverymode", "type": "string" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters. Nash Recommended Input: Pickup order [insert order number] for [insert customer name] from [pickup business name].", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packagePickupStartTime": { "title": "Packagepickupstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packagePickupEndTime": { "title": "Packagepickupendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDropoffStartTime": { "title": "Packagedropoffstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDropoffEndTime": { "title": "Packagedropoffendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDescription": { "title": "Packagedescription", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageValue": { "title": "Packagevalue", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "packageValueCents": { "title": "Packagevaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "packageTax": { "title": "Packagetax", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "packageServiceFee": { "title": "Packageservicefee", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "tipAmount": { "title": "Tipamount", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "tipAmountUsd": { "title": "Tipamountusd", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "packageExternalIdentifier": { "title": "Packageexternalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageMinimumVehicleSize": { "title": "Packageminimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "packageRequirements": { "title": "Packagerequirements", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PackageRequirements" }, { "pattern": "^(custom|preferred):.*", "type": "string" } ] } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "weight": { "title": "Weight", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "dimensions": { "title": "Dimensions", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "packageItems": { "title": "Packageitems", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier for the job.", "default": null, "example": "mini-mart-order-99" }, "optionsGroupId": { "title": "Optionsgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dispatch strategy ID (formerly known as options group ID) for the job.", "default": null, "example": "dss_1yMhHj" }, "jobMetadata": { "title": "Jobmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Job metadata for the job.", "default": null, "example": { "key": "value" } }, "inputDatetimesLocalizedToPickupTz": { "title": "Inputdatetimeslocalizedtopickuptz", "type": "boolean", "description": "Whether the input datetimes are localized to the pickup timezone.", "default": false }, "quoteRequestOnly": { "title": "Quoterequestonly", "type": "boolean", "description": "Whether to only request a quote and not create a job.", "default": false } }, "description": "Expected payload for creating a job." }, "CreateJobInputSerializerAndAutodispatch": { "title": "CreateJobInputSerializerAndAutodispatch", "required": [ "packageDeliveryMode" ], "type": "object", "properties": { "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code], [country]. All address fields are required except \"second line\". Second line should include Apt/Suite/Unit/# appended to the number of the unit.", "default": null }, "pickupAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "pickupLatitude": { "title": "Pickuplatitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "pickupLongitude": { "title": "Pickuplongitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass \"Manager\". Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass \"Manager\". Limited to 80 characters.", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Google place ID for the pickup location.If passed, resolving the pickup location's lat/lng will happen with this field.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Nash store location ID for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the location in the form: \"+15555555555\"", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state], [zip code], [country]. All address fields are required except \"second line\". Second line should include Apt/Suite/Unit/# appended to the number of the unit.", "default": null }, "dropoffAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "dropoffLatitude": { "title": "Dropofflatitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "dropoffLongitude": { "title": "Dropofflongitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffExternalStoreLocationId": { "title": "Dropoffexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "packageDeliveryMode": { "title": "Packagedeliverymode", "type": "string" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters. Nash Recommended Input: Pickup order [insert order number] for [insert customer name] from [pickup business name].", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packagePickupStartTime": { "title": "Packagepickupstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packagePickupEndTime": { "title": "Packagepickupendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDropoffStartTime": { "title": "Packagedropoffstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDropoffEndTime": { "title": "Packagedropoffendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDescription": { "title": "Packagedescription", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageValue": { "title": "Packagevalue", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "packageValueCents": { "title": "Packagevaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "packageTax": { "title": "Packagetax", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "packageServiceFee": { "title": "Packageservicefee", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "tipAmount": { "title": "Tipamount", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "tipAmountUsd": { "title": "Tipamountusd", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "packageExternalIdentifier": { "title": "Packageexternalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageMinimumVehicleSize": { "title": "Packageminimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "packageRequirements": { "title": "Packagerequirements", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PackageRequirements" }, { "pattern": "^(custom|preferred):.*", "type": "string" } ] } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "weight": { "title": "Weight", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "dimensions": { "title": "Dimensions", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "packageItems": { "title": "Packageitems", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier for the job.", "default": null, "example": "mini-mart-order-99" }, "optionsGroupId": { "title": "Optionsgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dispatch strategy ID (formerly known as options group ID) for the job.", "default": null, "example": "dss_1yMhHj" }, "jobMetadata": { "title": "Jobmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Job metadata for the job.", "default": null, "example": { "key": "value" } }, "inputDatetimesLocalizedToPickupTz": { "title": "Inputdatetimeslocalizedtopickuptz", "type": "boolean", "description": "Whether the input datetimes are localized to the pickup timezone.", "default": false }, "quoteRequestOnly": { "title": "Quoterequestonly", "type": "boolean", "description": "Whether to only request a quote and not create a job.", "default": false }, "autodispatch": { "title": "Autodispatch", "type": "boolean", "default": false } }, "description": "Expected payload for creating a job and optionally autodispatch." }, "CreateNashAiInvalidPodTrigger": { "title": "CreateNashAiInvalidPodTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "nash_ai_invalid_pod" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateNoteInputSerializer": { "title": "CreateNoteInputSerializer", "required": [ "jobId", "note" ], "type": "object", "properties": { "jobId": { "title": "Jobid", "type": "string", "description": "The job ID to create a note for." }, "taskId": { "title": "Taskid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The task ID to create a note for.", "default": null }, "note": { "title": "Note", "type": "string", "description": "The note to create." } }, "description": "Expected payload for the create note endpoint." }, "CreateNotificationTriggerInput": { "title": "CreateNotificationTriggerInput", "oneOf": [ { "$ref": "#/components/schemas/CreateDeliveryStatusTransitionTrigger" }, { "$ref": "#/components/schemas/CreateDriverGeolocationTrigger" }, { "$ref": "#/components/schemas/CreateTaskReassignmentTrigger" }, { "$ref": "#/components/schemas/CreateDeliveryIncidentReportTrigger" }, { "$ref": "#/components/schemas/CreateStuckStatusTrigger" }, { "$ref": "#/components/schemas/CreateStatusChangedTooQuicklyTrigger" }, { "$ref": "#/components/schemas/CreateDriverLocationVsDeliveryStatusTrigger" }, { "$ref": "#/components/schemas/CreateDropoffDelayedTrigger" }, { "$ref": "#/components/schemas/CreatePickupDelayedTrigger" }, { "$ref": "#/components/schemas/CreateOrderNeedsAttentionTrigger" }, { "$ref": "#/components/schemas/CreateAutodispatchFailedTrigger" }, { "$ref": "#/components/schemas/CreateAddressValidationFailedTrigger" }, { "$ref": "#/components/schemas/CreateOrderReadyToFulfillTrigger" }, { "$ref": "#/components/schemas/CreateJobCreationFailedTrigger" }, { "$ref": "#/components/schemas/CreateTaskHealthStatusTrigger" }, { "$ref": "#/components/schemas/CreateTasksAttemptsExhaustedTrigger" }, { "$ref": "#/components/schemas/CreateDeliveryCancellationFailedTrigger" }, { "$ref": "#/components/schemas/CreateInternalDriverNotAssignedTrigger" }, { "$ref": "#/components/schemas/CreateNashAiInvalidPodTrigger" }, { "$ref": "#/components/schemas/CreateDeliveryCompletedTooEarlyTrigger" }, { "$ref": "#/components/schemas/CreateStatusTriggeredTooEarlyTrigger" }, { "$ref": "#/components/schemas/CreateOrderNotDispatchedCloseToPickupTrigger" }, { "$ref": "#/components/schemas/CreateRefundRequestTrigger" }, { "$ref": "#/components/schemas/CreateOptimizationOrderUnassignedTrigger" }, { "$ref": "#/components/schemas/CreateZoneGeolocationTrigger" }, { "$ref": "#/components/schemas/CreateApiBasedTrigger" }, { "$ref": "#/components/schemas/CreateOptimizationActionStatusTrigger" }, { "$ref": "#/components/schemas/CreateDriverStackingTrigger" }, { "$ref": "#/components/schemas/CreateTimeElapsedSinceStatusTrigger" }, { "$ref": "#/components/schemas/CreateActivityStatusTransitionTrigger" }, { "$ref": "#/components/schemas/CreateDemoTrigger" }, { "$ref": "#/components/schemas/CreateCustomEventListenerTrigger" }, { "$ref": "#/components/schemas/CreateProofOfDeliveryUploadedTrigger" }, { "$ref": "#/components/schemas/CreateCourierUpdatedTrigger" }, { "$ref": "#/components/schemas/CreateTimingUpdatedTrigger" }, { "$ref": "#/components/schemas/CreateAiConversationCompletedTrigger" }, { "$ref": "#/components/schemas/CreateDeliveryWindowBookedTimeoutTrigger" }, { "$ref": "#/components/schemas/CreateOrderModifiedTrigger" }, { "$ref": "#/components/schemas/CreateRouteStatusTransitionTrigger" }, { "$ref": "#/components/schemas/CreateOrderTimeTrigger" }, { "$ref": "#/components/schemas/CreateConversationMessageReceivedTrigger" }, { "$ref": "#/components/schemas/CreateConversationAssignedTrigger" }, { "$ref": "#/components/schemas/CreateConversationResolvedTrigger" }, { "$ref": "#/components/schemas/CreateConversationReopenedTrigger" }, { "$ref": "#/components/schemas/CreateConversationHandlerChangedTrigger" } ], "description": "Root serializer for POST /v1/notification-triggers.\n\nThin wrapper over the ``type``-discriminated union so flask-openapi3 can\nconsume it as a body type; callers send the trigger object directly at\nthe top level of the JSON body.", "discriminator": { "propertyName": "type", "mapping": { "activity_status_transition": "#/components/schemas/CreateActivityStatusTransitionTrigger", "address_validation_failed": "#/components/schemas/CreateAddressValidationFailedTrigger", "ai_conversation_completed": "#/components/schemas/CreateAiConversationCompletedTrigger", "api_based": "#/components/schemas/CreateApiBasedTrigger", "autodispatch_failed": "#/components/schemas/CreateAutodispatchFailedTrigger", "conversation_assigned": "#/components/schemas/CreateConversationAssignedTrigger", "conversation_handler_changed": "#/components/schemas/CreateConversationHandlerChangedTrigger", "conversation_message_received": "#/components/schemas/CreateConversationMessageReceivedTrigger", "conversation_reopened": "#/components/schemas/CreateConversationReopenedTrigger", "conversation_resolved": "#/components/schemas/CreateConversationResolvedTrigger", "courier_updated": "#/components/schemas/CreateCourierUpdatedTrigger", "custom_event_listener": "#/components/schemas/CreateCustomEventListenerTrigger", "delivery_cancellation_failed": "#/components/schemas/CreateDeliveryCancellationFailedTrigger", "delivery_completed_too_early": "#/components/schemas/CreateDeliveryCompletedTooEarlyTrigger", "delivery_incident_report": "#/components/schemas/CreateDeliveryIncidentReportTrigger", "delivery_status_transition": "#/components/schemas/CreateDeliveryStatusTransitionTrigger", "delivery_window_booked_timeout": "#/components/schemas/CreateDeliveryWindowBookedTimeoutTrigger", "demo": "#/components/schemas/CreateDemoTrigger", "driver_geolocation": "#/components/schemas/CreateDriverGeolocationTrigger", "driver_location_vs_delivery_status": "#/components/schemas/CreateDriverLocationVsDeliveryStatusTrigger", "driver_stacking": "#/components/schemas/CreateDriverStackingTrigger", "dropoff_delayed": "#/components/schemas/CreateDropoffDelayedTrigger", "internal_driver_not_assigned": "#/components/schemas/CreateInternalDriverNotAssignedTrigger", "job_creation_failed": "#/components/schemas/CreateJobCreationFailedTrigger", "nash_ai_invalid_pod": "#/components/schemas/CreateNashAiInvalidPodTrigger", "optimization_action_status": "#/components/schemas/CreateOptimizationActionStatusTrigger", "optimization_order_unassigned": "#/components/schemas/CreateOptimizationOrderUnassignedTrigger", "order_cutoff_time": "#/components/schemas/CreateOrderTimeTrigger", "order_dropoff_end_time": "#/components/schemas/CreateOrderTimeTrigger", "order_dropoff_start_time": "#/components/schemas/CreateOrderTimeTrigger", "order_modified": "#/components/schemas/CreateOrderModifiedTrigger", "order_needs_attention": "#/components/schemas/CreateOrderNeedsAttentionTrigger", "order_not_dispatched_close_to_pickup": "#/components/schemas/CreateOrderNotDispatchedCloseToPickupTrigger", "order_pickup_end_time": "#/components/schemas/CreateOrderTimeTrigger", "order_pickup_start_time": "#/components/schemas/CreateOrderTimeTrigger", "order_ready_to_fulfill": "#/components/schemas/CreateOrderReadyToFulfillTrigger", "pickup_delayed": "#/components/schemas/CreatePickupDelayedTrigger", "proof_of_delivery_uploaded": "#/components/schemas/CreateProofOfDeliveryUploadedTrigger", "refund_request": "#/components/schemas/CreateRefundRequestTrigger", "route_status_transition": "#/components/schemas/CreateRouteStatusTransitionTrigger", "status_changed_too_quickly": "#/components/schemas/CreateStatusChangedTooQuicklyTrigger", "status_triggered_too_early": "#/components/schemas/CreateStatusTriggeredTooEarlyTrigger", "stuck_status": "#/components/schemas/CreateStuckStatusTrigger", "task_health_status": "#/components/schemas/CreateTaskHealthStatusTrigger", "task_reassignment": "#/components/schemas/CreateTaskReassignmentTrigger", "tasks_attempts_exhausted": "#/components/schemas/CreateTasksAttemptsExhaustedTrigger", "time_elapsed_since_status": "#/components/schemas/CreateTimeElapsedSinceStatusTrigger", "timing_updated": "#/components/schemas/CreateTimingUpdatedTrigger", "zone_geolocation": "#/components/schemas/CreateZoneGeolocationTrigger" } } }, "CreateOptimizationActionStatusTrigger": { "title": "CreateOptimizationActionStatusTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "optimization_action_status" }, "parameters": { "$ref": "#/components/schemas/OptimizationActionStatusParams" } } }, "CreateOptimizationOrderUnassignedTrigger": { "title": "CreateOptimizationOrderUnassignedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "optimization_order_unassigned" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateOptimizationStrategyInputSerializer": { "title": "CreateOptimizationStrategyInputSerializer", "required": [ "label" ], "type": "object", "properties": { "optimizationSchedules": { "title": "Optimizationschedules", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OptimizationScheduleInputSerializer" } }, { "type": "null" } ], "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contracts considered during optimization.", "default": null }, "shiftContractId": { "title": "Shiftcontractid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Contract id of the provider supplying shifts for this strategy.", "default": null }, "pickupServiceTimeSeconds": { "title": "Pickupservicetimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "dropoffServiceTimeSeconds": { "title": "Dropoffservicetimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "incrementalServiceTimeSeconds": { "title": "Incrementalservicetimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "enableAutoDispatch": { "title": "Enableautodispatch", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "autodispatchWithinXMinutesOfPickupTime": { "title": "Autodispatchwithinxminutesofpickuptime", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.", "default": null }, "earliestDispatchMinutesBeforePickup": { "title": "Earliestdispatchminutesbeforepickup", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.", "default": null }, "pickupTimeFromInMinutes": { "title": "Pickuptimefrominminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Lower bound (inclusive) of the pickup time window to optimize, in minutes from now.", "default": null }, "pickupTimeToInMinutes": { "title": "Pickuptimetoinminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Upper bound (exclusive) of the pickup time window to optimize, in minutes from now.", "default": null }, "contractOptimizationOverrideParameters": { "title": "Contractoptimizationoverrideparameters", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContractOverrideParametersSerializer" } }, { "type": "null" } ], "default": null }, "unassignedOrdersOptionsGroupId": { "title": "Unassignedordersoptionsgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "defaultTrafficSource": { "title": "Defaulttrafficsource", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "trafficTimeOffsetWeeks": { "title": "Traffictimeoffsetweeks", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "avoidFerries": { "title": "Avoidferries", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Route around water crossings. Ferries are usually unusable by truck fleets, and the solver otherwise prices a sailing as ordinary driving time.", "default": null }, "minimizeZoneCrossings": { "title": "Minimizezonecrossings", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Prefer fewer crossings of selected zone polygons in LogisticsOS. Null disables the preference.", "default": null }, "communityZoneIds": { "title": "Communityzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Reusable zone references. Omit to preserve the selection; null or an empty list clears it.", "default": null }, "zones": { "title": "Zones", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone ids assigned to this strategy.", "default": null }, "storeLocations": { "title": "Storelocations", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Store location ids assigned to this strategy.", "default": null }, "softCapabilities": { "title": "Softcapabilities", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "searchLevel": { "title": "Searchlevel", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "clusteringLevel": { "title": "Clusteringlevel", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "softClusterLabel": { "title": "Softclusterlabel", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "balanceRoutes": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationBalanceRoutes" }, { "type": "null" } ], "default": null }, "engineSolver": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationSolver" }, { "type": "null" } ], "default": null }, "saveOptimizedRoutes": { "title": "Saveoptimizedroutes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "dynamicCadenceConfig": { "anyOf": [ { "$ref": "#/components/schemas/DynamicCadenceConfigInputSerializer" }, { "type": "null" } ], "default": null }, "label": { "title": "Label", "type": "string", "description": "Human-readable name for the strategy." } } }, "CreateOrderBulkPayload": { "title": "CreateOrderBulkPayload", "required": [ "action", "data" ], "type": "object", "properties": { "action": { "title": "Action", "type": "string", "const": "create" }, "data": { "$ref": "#/components/schemas/OrderInput" } } }, "CreateOrderModifiedTrigger": { "title": "CreateOrderModifiedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "order_modified" }, "parameters": { "anyOf": [ { "$ref": "#/components/schemas/OrderModifiedParams" }, { "type": "null" } ], "default": null } } }, "CreateOrderNeedsAttentionTrigger": { "title": "CreateOrderNeedsAttentionTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "order_needs_attention" }, "parameters": { "$ref": "#/components/schemas/OrderNeedsAttentionParams" } } }, "CreateOrderNotDispatchedCloseToPickupTrigger": { "title": "CreateOrderNotDispatchedCloseToPickupTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "order_not_dispatched_close_to_pickup" }, "parameters": { "$ref": "#/components/schemas/OrderNotDispatchedParams" } } }, "CreateOrderReadyToFulfillTrigger": { "title": "CreateOrderReadyToFulfillTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "order_ready_to_fulfill" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateOrderTimeTrigger": { "title": "CreateOrderTimeTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "enum": [ "order_pickup_start_time", "order_pickup_end_time", "order_dropoff_start_time", "order_dropoff_end_time", "order_cutoff_time" ], "type": "string" }, "parameters": { "$ref": "#/components/schemas/OrderTimeParams" } } }, "CreateOrdersInput": { "title": "CreateOrdersInput", "required": [ "orders" ], "type": "object", "properties": { "orders": { "title": "Orders", "type": "array", "items": { "$ref": "#/components/schemas/OrderInput" }, "description": "List of orders to create" } } }, "CreatePickupDelayedTrigger": { "title": "CreatePickupDelayedTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "pickup_delayed" }, "parameters": { "$ref": "#/components/schemas/PickupDelayedParams" } } }, "CreateProofOfDeliveryUploadedTrigger": { "title": "CreateProofOfDeliveryUploadedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "proof_of_delivery_uploaded" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateRefundRequestTrigger": { "title": "CreateRefundRequestTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "refund_request" }, "parameters": { "$ref": "#/components/schemas/RefundRequestParams" } } }, "CreateRouteStatusTransitionTrigger": { "title": "CreateRouteStatusTransitionTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "route_status_transition" }, "parameters": { "anyOf": [ { "$ref": "#/components/schemas/RouteStatusTransitionParams" }, { "type": "null" } ], "default": null } } }, "CreateShiftInputSerializer": { "title": "CreateShiftInputSerializer", "required": [ "name", "plannedStart", "plannedEnd" ], "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the shift.", "default": null, "example": "sft_fKUFVWZQGbEfsyMwJYntE2" }, "name": { "title": "Name", "type": "string", "description": "The name of the shift.", "example": "Shift 1" }, "plannedStart": { "title": "Plannedstart", "type": "string", "description": "The planned start timestamp of the shift.", "example": "2021-01-01T00:00:00Z" }, "plannedEnd": { "title": "Plannedend", "type": "string", "description": "The planned end timestamp of the shift.", "example": "2021-01-01T00:00:00Z" }, "plannedBreakDuration": { "title": "Plannedbreakduration", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The planned break duration of the shift.", "default": null, "example": 30 }, "shiftMetadata": { "title": "Shiftmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the shift.", "default": null, "example": { "key": "value" } }, "optimizationParams": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParams" }, { "type": "null" } ], "description": "The optimization parameters of the shift.", "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The status of the shift.", "default": null, "example": "active" }, "storeLocationId": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The store location ID of the shift.", "default": null, "example": "123" }, "externalStoreLocationId": { "title": "Externalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external store location ID of the shift.", "default": null, "example": "123" }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The zone IDs of the shift.", "default": null, "example": [ "123" ] }, "externalZoneIds": { "title": "Externalzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The external zone IDs of the shift.", "default": null, "example": [ "123" ] } }, "description": "Input for creating a shift." }, "CreateShiftsInputSerializer": { "title": "CreateShiftsInputSerializer", "required": [ "shifts" ], "type": "object", "properties": { "shifts": { "title": "Shifts", "type": "array", "items": { "$ref": "#/components/schemas/CreateShiftInputSerializer" } } }, "description": "Input for creating multiple shifts." }, "CreateStatusChangedTooQuicklyTrigger": { "title": "CreateStatusChangedTooQuicklyTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "status_changed_too_quickly" }, "parameters": { "$ref": "#/components/schemas/StatusesChangedTooQuicklyParams" } } }, "CreateStatusTriggeredTooEarlyTrigger": { "title": "CreateStatusTriggeredTooEarlyTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "status_triggered_too_early" }, "parameters": { "$ref": "#/components/schemas/StatusTriggeredTooEarlyParams" } } }, "CreateStoreLocationInputSerializer": { "title": "CreateStoreLocationInputSerializer", "required": [ "name", "phoneNumber" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string", "description": "Store business name at the origin. Limited to 80 characters." }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.", "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.", "default": null }, "phoneNumber": { "title": "Phonenumber", "type": "string", "description": "The phone number to contact at the store location: '+15555555555'" }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for store location. Limited to 280 characters. Nash Recommended Input: Order [insert order number] for [insert customer name] from [business name]", "default": null }, "address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the store location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code]. All address fields are required except 'second line'. Second line should include Apt/Suite/Unit/# appended to the number of the unit. Can be null if using address_components.", "default": null }, "addressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "description": "A geocoded and componentized version of the pickup address. NOTE: THIS WILL BYPASS OUR ADDRESS GEOCODING SERVICE!", "default": null }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Store location unique identifier from an external system.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Free form tags specific to the location.", "default": null, "example": "['service:rapid', 'service:express', 'franchise_location']" }, "operatingHours": { "title": "Operatinghours", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "[Integration Specific]: An object with keys that correspond to days of week (monday, tuesday, etc) and their corresponding operating hours / delivery windows. Example: {monday: {active: true, shifts: [[10:00, 17:00]]}, tuesday: {active: true, shifts: [[10:00, 17:00]]}, wednesday: {active: true, shifts: [[10:00, 17:00]]}, thursday: {active: true, shifts: [[10:00, 17:00]]}, friday: {active: true, shifts: [[10:00, 17:00]]}, saturday: {active: true, shifts: []}, sunday: {active: true, shifts: []}}", "default": null }, "prepTimeMinutes": { "title": "Preptimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "[Integration Specific]: the preparation time to apply for orders, if relying on Nash to compute the delivery windows. This only applies to specific integrations.", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The zone ids to associate with the store location.", "default": null, "example": [ "zone_01234567890123456789", "zone_01234567890123456789" ] }, "zoneAssociations": { "title": "Zoneassociations", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "The zone associations to associate with the store location.", "default": null, "example": [ { "end_date": "2025-01-01", "start_date": "2024-01-01", "zone_id": "zone_01234567890123456789" } ] } }, "description": "Expected payload for creating a store location." }, "CreateStuckStatusTrigger": { "title": "CreateStuckStatusTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "stuck_status" }, "parameters": { "$ref": "#/components/schemas/StuckStatusParams" } } }, "CreateTaskHealthStatusTrigger": { "title": "CreateTaskHealthStatusTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "task_health_status" }, "parameters": { "$ref": "#/components/schemas/TaskHealthStatusParams" } } }, "CreateTaskReassignmentTrigger": { "title": "CreateTaskReassignmentTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "task_reassignment" }, "parameters": { "$ref": "#/components/schemas/TaskReassignmentParams" } } }, "CreateTasksAttemptsExhaustedTrigger": { "title": "CreateTasksAttemptsExhaustedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "tasks_attempts_exhausted" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateTemplateInputSerializer": { "title": "CreateTemplateInputSerializer", "required": [ "type" ], "type": "object", "properties": { "type": { "title": "Type", "type": "string", "description": "Template type (e.g., DELIVERY_WINDOW)", "example": "DELIVERY_WINDOW" }, "deliveryWindowTemplatePayload": { "title": "Deliverywindowtemplatepayload", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Required for DELIVERY_WINDOW templates", "default": null, "example": { "key": "value" } }, "shiftTemplatePayload": { "title": "Shifttemplatepayload", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Required for SHIFT templates", "default": null, "example": { "key": "value" } }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier for the template", "default": null, "example": "ext_01234567890123456789" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the template.", "default": null, "example": "Monday Delivery Window" }, "startDatetime": { "title": "Startdatetime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The start datetime of the template.", "default": null, "example": "2024-01-01T12:00:00" }, "endDatetime": { "title": "Enddatetime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The end datetime of the template.", "default": null, "example": "2024-01-01T12:00:00" }, "daysOfWeek": { "title": "Daysofweek", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Days of the week for template usage", "default": null, "example": [ "MONDAY", "TUESDAY" ] }, "generationFrequencyValue": { "title": "Generationfrequencyvalue", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How often to create instances (value)", "default": null, "example": 1 }, "generationFrequencyUnit": { "title": "Generationfrequencyunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "How often to create instances (unit)", "default": null, "example": "DAY" }, "createInstancesUpToValue": { "title": "Createinstancesuptovalue", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "How far into the future to create instances (value)", "default": null, "example": 1 }, "createInstancesUpToUnit": { "title": "Createinstancesuptounit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "How far into the future to create instances (unit)", "default": null, "example": "DAY" }, "overrideExistingInstances": { "title": "Overrideexistinginstances", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether to overwrite existing instances", "default": null, "example": true } }, "description": "Expected payload for creating a template." }, "CreateTemplatesInputSerializer": { "title": "CreateTemplatesInputSerializer", "required": [ "templates" ], "type": "object", "properties": { "templates": { "title": "Templates", "type": "array", "items": { "$ref": "#/components/schemas/CreateTemplateInputSerializer" } } }, "description": "Expected payload for creating multiple templates." }, "CreateTimeElapsedSinceStatusTrigger": { "title": "CreateTimeElapsedSinceStatusTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "time_elapsed_since_status" }, "parameters": { "$ref": "#/components/schemas/TimeElapsedSinceStatusParams" } } }, "CreateTimingUpdatedTrigger": { "title": "CreateTimingUpdatedTrigger", "required": [ "name", "notificationGroupIds", "type" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "timing_updated" }, "parameters": { "$ref": "#/components/schemas/_NoParams" } } }, "CreateVehicleInputSerializer": { "title": "CreateVehicleInputSerializer", "required": [ "name", "enabled" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string", "description": "The name of the vehicle.", "example": "Vehicle 1" }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the vehicle is enabled.", "example": true }, "externalidentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier of the vehicle.", "default": null, "example": "vehicle_ext_1" }, "vehicleinfo": { "anyOf": [ { "$ref": "#/components/schemas/VehicleInfo" }, { "type": "null" } ], "description": "The vehicle info of the vehicle.", "default": null, "example": { "color": "Red", "licensePlate": "ABC123", "make": "Toyota", "model": "Camry", "type": "car", "year": "2020" } }, "vehicleconfig": { "anyOf": [ { "$ref": "#/components/schemas/VehicleConfig" }, { "type": "null" } ], "description": "The vehicle config of the vehicle.", "default": null, "example": { "height": 1000, "length": 1000, "maxDistance": 1000, "maxDuration": 1000, "maxStops": 1000, "speedFactor": 1.0, "weight": 1000, "width": 1000 } }, "courierids": { "title": "Courierids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The couriers of the vehicle.", "default": null, "example": [ "cor_1", "cor_2" ] } }, "description": "Input for creating a vehicle." }, "CreateWorkflowInputSerializer": { "title": "CreateWorkflowInputSerializer", "required": [ "name", "nodes", "edges", "trigger" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowStatus" }, { "type": "null" } ], "default": null }, "nodes": { "title": "Nodes", "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNodeInputSerializer" } }, "edges": { "title": "Edges", "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEdgeInputSerializer" } }, "trigger": { "$ref": "#/components/schemas/WorkflowTriggerInputSerializer" } } }, "CreateZoneGeolocationTrigger": { "title": "CreateZoneGeolocationTrigger", "required": [ "name", "notificationGroupIds", "type", "parameters" ], "type": "object", "properties": { "name": { "title": "Name", "minLength": 1, "type": "string", "description": "Human-readable name for this trigger instance." }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "IDs of the notification groups that will receive notifications when this trigger fires." }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the trigger.", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled on creation. Defaults to true.", "default": true }, "message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional custom message body.", "default": null }, "flag": { "title": "Flag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether firing this trigger should also flag the job for operator attention.", "default": null }, "autoResolveFlag": { "title": "Autoresolveflag", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, a flag raised by this trigger resolves automatically when the flag condition clears.", "default": null }, "optionsGroupIds": { "title": "Optionsgroupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Options groups that scope when this trigger applies.", "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contract IDs that scope when this trigger applies.", "default": null }, "isInternal": { "title": "Isinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the trigger is for internal use only (not exposed to customers).", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone IDs that scope when this trigger applies (separate from zone-geolocation parameters).", "default": null }, "customEventName": { "title": "Customeventname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For triggers that emit a custom event when fired, the name of that event.", "default": null }, "conditionalLogic": { "title": "Conditionallogic", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Optional AND/OR conditional tree that gates when the trigger fires. Shape mirrors the Zod ConditionalStatement schema in nash-ui; currently passed through as JSON. A follow-up will type this explicitly.", "default": null }, "type": { "title": "Type", "type": "string", "const": "zone_geolocation" }, "parameters": { "$ref": "#/components/schemas/ZoneGeolocationParams" } } }, "CreateZoneInputSerializer": { "title": "CreateZoneInputSerializer", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Zone unique identifier from an external system.", "default": null }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the zone.", "default": null, "example": "Zone 1" }, "coverageAreaId": { "title": "Coverageareaid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The coverage area id to associate with the zone.", "default": null }, "polygon": { "title": "Polygon", "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, { "type": "null" } ], "description": "The zone boundary, as a single closed ring of [latitude, longitude] coordinate pairs. The first and last point must be identical to close the ring. Setting this creates a coverage area for the zone (or replaces the polygon on its existing coverage area).", "default": null, "example": [ [ 37.7749, -122.4194 ], [ 37.8049, -122.4194 ], [ 37.8049, -122.3894 ], [ 37.7749, -122.3894 ], [ 37.7749, -122.4194 ] ] }, "storeLocationIds": { "title": "Storelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The store location ids to associate with the zone.", "default": null, "example": [ "stl_01234567890123456789", "stl_01234567890123456789" ] }, "storeLocationAssociations": { "title": "Storelocationassociations", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "The store location associations to associate with the zone.", "default": null, "example": [ { "end_date": "2025-01-01", "start_date": "2024-01-01", "store_location_id": "stl_01234567890123456789" } ] }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Free form tags specific to the location.", "default": null, "example": "['service:rapid', 'service:express', 'franchise_location']" }, "zoneMetadata": { "title": "Zonemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the zone.", "default": null, "example": { "key": "value" } } }, "description": "Expected payload for creating a zone." }, "CreateZoneRestrictionInputSerializer": { "title": "CreateZoneRestrictionInputSerializer", "required": [ "name" ], "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external ID of the zone restriction.", "default": null }, "name": { "title": "Name", "type": "string", "description": "The name of the zone restriction." }, "isActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the zone restriction is active.", "default": null }, "restrictionMetadata": { "title": "Restrictionmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the zone restriction.", "default": null, "example": { "key": "value" } } }, "description": "Expected payload for the create zone restriction endpoint." }, "CreatedDispatchPlan": { "title": "CreatedDispatchPlan", "required": [ "planId", "revision", "unplannedOrderCount" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "unplannedOrderCount": { "title": "Unplannedordercount", "type": "integer" } } }, "CustomEventListenerParams": { "title": "CustomEventListenerParams", "required": [ "eventNames" ], "type": "object", "properties": { "eventNames": { "title": "Eventnames", "minItems": 1, "type": "array", "items": { "type": "string" } } } }, "DayTime": { "title": "DayTime", "required": [ "day_offset", "time" ], "type": "object", "properties": { "day_offset": { "title": "Day Offset", "maximum": 1, "minimum": -3.0, "type": "integer" }, "time": { "title": "Time", "type": "string", "format": "time" } }, "description": "A local time relative to a load's delivery day, e.g. noon the day before." }, "DeleteOrderBulkPayload": { "title": "DeleteOrderBulkPayload", "required": [ "action", "data" ], "type": "object", "properties": { "action": { "title": "Action", "type": "string", "const": "delete" }, "data": { "$ref": "#/components/schemas/OrderIdPath" } } }, "DeleteRouteRestrictionResponse": { "title": "DeleteRouteRestrictionResponse", "type": "object", "properties": { "success": { "title": "Success", "type": "boolean", "default": true } } }, "DeleteStoreLocationResponse": { "title": "DeleteStoreLocationResponse", "required": [ "id", "isDeleted" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "isDeleted": { "title": "Isdeleted", "type": "boolean" } }, "description": "Layered DELETE confirmation. Returns the deleted store id and the new soft-delete flag." }, "DeliveryCompletedTooEarlyParams": { "title": "DeliveryCompletedTooEarlyParams", "required": [ "metricValue" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" } } }, "DeliveryFailure": { "title": "DeliveryFailure", "required": [ "code" ], "type": "object", "properties": { "code": { "$ref": "#/components/schemas/DeliveryFailureCode", "description": "Failure code." }, "reason": { "title": "Reason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Free-text detail.", "default": null } }, "description": "Structured cause when a delivery enters ``failed`` or ``canceled_by_provider``." }, "DeliveryFailureCode": { "title": "DeliveryFailureCode", "enum": [ "customer_unavailable", "address_not_found", "out_of_service_area", "damage_in_transit", "item_unavailable", "age_verification_failed", "no_capacity", "other" ], "type": "string" }, "DeliveryIncidentInputSerializer": { "title": "DeliveryIncidentInputSerializer", "required": [ "raiseIncident", "incidentNotes" ], "type": "object", "properties": { "raiseIncident": { "title": "Raiseincident", "type": "boolean", "description": "Flag delivery to be reviewed by Nash's team (not for urgent cases). Set to False to indicate issue has been resolved" }, "incidentNotes": { "title": "Incidentnotes", "maxLength": 512, "type": "string", "description": "Details about incident" }, "incidentType": { "title": "Incidenttype", "enum": [ "REFUND_REQUEST", "COURIER_NOTES" ], "type": "string", "description": "Courier Notes or Refund Request", "default": "COURIER_NOTES" }, "incidentSubtype": { "anyOf": [ { "$ref": "#/components/schemas/RefundRequestType" }, { "type": "null" } ], "description": "Refund Request type", "default": null }, "incidentFileUrl": { "title": "Incidentfileurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Url to file attachment for refund request", "default": null }, "incidentFileUrls": { "title": "Incidentfileurls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Urls to file attachments for refund request", "default": null }, "requestAmountDeliveryFeeCents": { "title": "Requestamountdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the delivery fee in cents.", "default": null }, "requestAmountOrderValueCents": { "title": "Requestamountordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the order value in cents.", "default": null }, "requestAmountTipCents": { "title": "Requestamounttipcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the tip in cents.", "default": null } } }, "DeliveryIncidentOutputSerializer": { "title": "DeliveryIncidentOutputSerializer", "required": [ "jobId", "taskId", "raiseIncident", "incidentNotes", "incidentType", "incidentSubtype", "incidentFileUrl", "incidentFileUrls" ], "type": "object", "properties": { "jobId": { "title": "Jobid", "type": "string" }, "taskId": { "title": "Taskid", "type": "string" }, "raiseIncident": { "title": "Raiseincident", "type": "boolean" }, "incidentNotes": { "title": "Incidentnotes", "type": "string" }, "incidentType": { "title": "Incidenttype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "incidentSubtype": { "title": "Incidentsubtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "incidentFileUrl": { "title": "Incidentfileurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "incidentFileUrls": { "title": "Incidentfileurls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "refundRequestId": { "title": "Refundrequestid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the refund request.", "default": null }, "requestAmountDeliveryFeeCents": { "title": "Requestamountdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the delivery fee in cents.", "default": null }, "requestAmountOrderValueCents": { "title": "Requestamountordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the order value in cents.", "default": null }, "requestAmountTipCents": { "title": "Requestamounttipcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the tip in cents.", "default": null } } }, "DeliveryIncidentReportParams": { "title": "DeliveryIncidentReportParams", "type": "object", "properties": { "dirType": { "title": "Dirtype", "enum": [ "all", "refund_request" ], "type": "string", "default": "all" }, "dirCreated": { "title": "Dircreated", "type": "boolean", "default": false }, "dirResolved": { "title": "Dirresolved", "type": "boolean", "default": false } } }, "DeliverySerializer": { "title": "DeliverySerializer", "required": [ "id", "status", "isActive", "priceCents", "currency" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Delivery ID", "example": "dlv_01234567890" }, "type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "title": "Status", "type": "string", "description": "Delivery status", "example": "dropoff_complete" }, "statusHistory": { "title": "Statushistory", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "Delivery status history. `location` is the carrier's scan location, null when none was reported. `injected` marks skipped-status injection only; ETA/GPS-inferred arrivals may be null.", "default": null, "example": [ { "createdAt": "2023-08-29T19:17:46.264523", "location": null, "status": "created" }, { "createdAt": "2023-08-30T02:55:27.240246", "location": "WELSHPOOL WA", "status": "in_transit", "statusDescription": "Item processed at sorting facility" } ] }, "isActive": { "title": "Isactive", "type": "boolean", "description": "Is the delivery active" }, "pickupEta": { "title": "Pickupeta", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup ETA", "default": null }, "dropoffEta": { "title": "Dropoffeta", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff ETA", "default": null }, "dropoffDeadline": { "title": "Dropoffdeadline", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff deadline", "default": null }, "priceCents": { "title": "Pricecents", "type": "integer", "description": "Price in cents" }, "currency": { "title": "Currency", "type": "string", "description": "Currency" }, "documents": { "title": "Documents", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DocumentSerializer" } }, { "type": "null" } ], "description": "Documents", "default": null }, "nashFeeCents": { "title": "Nashfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Nash fee in cents", "default": null }, "courierName": { "title": "Couriername", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier name", "default": null }, "courierPhoneNumber": { "title": "Courierphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier phone number", "default": null }, "courierPickupPhoneNumber": { "title": "Courierpickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier pickup phone number", "default": null }, "courierDropoffPhoneNumber": { "title": "Courierdropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier dropoff phone number", "default": null }, "courierLocation": { "title": "Courierlocation", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Courier location", "default": null }, "courierVehicle": { "title": "Couriervehicle", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Courier vehicle", "default": null }, "courierProfileImage": { "title": "Courierprofileimage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier profile image", "default": null }, "proofOfDelivery": { "title": "Proofofdelivery", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "Proof of delivery. When file links are enabled, Nash-hosted photo items include secure_url alongside url. Authenticate with Nash to open secure_url; it redirects to a temporary download URL. Store secure_url, not the redirect target, and do not forward your API key to that target.", "default": null }, "providerDeliveryId": { "title": "Providerdeliveryid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider delivery id", "default": null }, "providerBatchId": { "title": "Providerbatchid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider batch id", "default": null }, "price": { "title": "Price", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Price", "default": null }, "taxAmountCents": { "title": "Taxamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tax amount in cents", "default": null }, "tollFeeCents": { "title": "Tollfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Toll fee in cents", "default": null }, "waitFeeCents": { "title": "Waitfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Wait fee in cents", "default": null }, "waitTimeMinutes": { "title": "Waittimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Wait time in minutes", "default": null }, "cancellationFeeCents": { "title": "Cancellationfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cancellation fee in cents", "default": null }, "returnFeeCents": { "title": "Returnfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Return fee in cents", "default": null }, "bonusPayCents": { "title": "Bonuspaycents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Bonus pay in cents", "default": null }, "otherProviderFees": { "title": "Otherproviderfees", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Other provider fees", "default": null }, "insuranceFeeCents": { "title": "Insurancefeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Insurance fee in cents", "default": null }, "totalPriceBreakdown": { "title": "Totalpricebreakdown", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Total price breakdown", "default": null }, "totalPriceCents": { "title": "Totalpricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Total price in cents", "default": null }, "pickedItems": { "title": "Pickeditems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PickedItemsSerializer" } }, { "type": "null" } ], "description": "Picked items", "default": null } }, "description": "Generic serializer for deliveries used in many endpoints.\n\nSome endpoints won't return all fields, so they are optional. This means that they will return field names with\nnull values." }, "DeliveryStatusTransitionParams": { "title": "DeliveryStatusTransitionParams", "type": "object", "anyOf": [ { "required": [ "deliveryStatus" ], "properties": { "deliveryStatus": { "minLength": 1, "type": "string" } } }, { "required": [ "deliveryStatuses" ], "properties": { "deliveryStatuses": { "minItems": 1, "type": "array" } } } ], "properties": { "deliveryStatus": { "title": "Deliverystatus", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Legacy single delivery status that triggers the notification.", "default": null }, "deliveryStatuses": { "title": "Deliverystatuses", "anyOf": [ { "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" } }, { "type": "null" } ], "description": "Delivery statuses that independently trigger the notification. This list takes precedence over deliveryStatus when both are supplied.", "default": null }, "sendScheduledMessage": { "title": "Sendscheduledmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, schedule the message to send at a later time instead of firing immediately.", "default": null }, "scheduledSendDeltaMinutes": { "title": "Scheduledsenddeltaminutes", "anyOf": [ { "maximum": 4320, "minimum": 15.0, "type": "integer" }, { "type": "null" } ], "description": "Minutes after the status transition to send the scheduled message (15 min to 3 days).", "default": null } } }, "DeliveryStatusUpdateValue": { "title": "DeliveryStatusUpdateValue", "enum": [ "not_assigned_driver", "assigned_driver", "pickup_enroute", "pickup_arrived", "items_pick_complete", "pickup_complete", "dropoff_enroute", "dropoff_arrived", "dropoff_complete", "failed", "canceled_by_provider", "return_in_progress", "return_arrived", "returned_to_store" ], "type": "string", "description": "Lifecycle states a fleet can report for a delivery.\n\nOrdered roughly chronologically:\n\n- ``not_assigned_driver`` \u2014 provider received the dispatch but hasn't found a driver.\n- ``assigned_driver`` \u2014 a driver has accepted the dispatch but hasn't departed.\n- ``pickup_enroute`` \u2014 driver is on the way to the pickup location.\n- ``pickup_arrived`` \u2014 driver is at the pickup location.\n- ``items_pick_complete`` \u2014 every item of the order has been picked; the driver is still at the pickup location.\n- ``pickup_complete`` \u2014 package has been picked up.\n- ``dropoff_enroute`` \u2014 driver is on the way to the customer.\n- ``dropoff_arrived`` \u2014 driver is at the customer.\n- ``dropoff_complete`` \u2014 package delivered (terminal success).\n- ``failed`` \u2014 delivery aborted; pair with ``failure`` block (terminal).\n- ``canceled_by_provider`` \u2014 provider canceled the dispatch (terminal).\n- ``return_in_progress`` \u2014 package is being returned to the pickup location.\n- ``return_arrived`` \u2014 driver is at the pickup location to return.\n- ``returned_to_store`` \u2014 package returned (terminal)." }, "DeliveryUpdate": { "title": "DeliveryUpdate", "type": "object", "properties": { "status": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryStatusUpdateValue" }, { "type": "null" } ], "description": "New lifecycle status.", "default": null }, "coordinates": { "anyOf": [ { "$ref": "#/components/schemas/Coordinates" }, { "type": "null" } ], "description": "Current courier coordinates.", "default": null }, "proofOfDelivery": { "title": "Proofofdelivery", "anyOf": [ { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ImageProof" }, { "$ref": "#/components/schemas/BarcodeProof" } ], "discriminator": { "propertyName": "podType", "mapping": { "barcode_scan_on_dropoff": "#/components/schemas/BarcodeProof", "barcode_scan_on_pickup": "#/components/schemas/BarcodeProof", "barcode_scan_on_return": "#/components/schemas/BarcodeProof", "photo_pre_delivery_verification": "#/components/schemas/ImageProof", "photo_proof_of_delivery": "#/components/schemas/ImageProof", "photo_proof_of_pickup": "#/components/schemas/ImageProof", "signature_proof_of_delivery": "#/components/schemas/ImageProof", "signature_proof_of_pickup": "#/components/schemas/ImageProof" } } } }, { "type": "null" } ], "description": "Proof artifacts captured at the stop. Image or barcode, discriminated by `podType`.", "default": null }, "pickedItems": { "title": "Pickeditems", "anyOf": [ { "maxItems": 200, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/PickedItem" } }, { "type": "null" } ], "description": "Every item picked for the delivery so far. Replaces the picked items the delivery holds, so each request sends the whole list, and sending it again changes nothing. Announced by the delivery's `items_pick_update` event when the list changed. At most 64 KB as JSON.", "default": null }, "courier": { "anyOf": [ { "$ref": "#/components/schemas/Courier" }, { "type": "null" } ], "description": "Identity and vehicle of the assigned courier.", "default": null }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryFailure" }, { "type": "null" } ], "description": "Cause when the delivery enters `failed` or `canceled_by_provider`.", "default": null }, "pickupNote": { "title": "Pickupnote", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Note from the courier at pickup. E.g. 'used the side door'.", "default": null }, "dropoffNote": { "title": "Dropoffnote", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Note from the courier at dropoff. E.g. 'left with concierge'.", "default": null }, "parkingLocation": { "title": "Parkinglocation", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the courier parked at the stop. E.g. 'loading bay 4'.", "default": null }, "returnParkingLocation": { "title": "Returnparkinglocation", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the courier parked when returning the package to the pickup location.", "default": null }, "pickupEta": { "title": "Pickupeta", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Estimated pickup arrival time. ISO 8601.", "default": null }, "dropoffEta": { "title": "Dropoffeta", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Estimated dropoff arrival time. ISO 8601.", "default": null }, "externalDeliveryId": { "title": "Externaldeliveryid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider's own identifier for this delivery.", "default": null } }, "description": "Partial update for a delivery dispatched to a Nash-connected provider." }, "DeliveryWindowBookedTimeoutParams": { "title": "DeliveryWindowBookedTimeoutParams", "required": [ "timeoutMinutes" ], "type": "object", "properties": { "timeoutMinutes": { "title": "Timeoutminutes", "minimum": 1.0, "type": "integer" } } }, "DeliveryWindowOutput": { "title": "DeliveryWindowOutput", "required": [ "id", "name", "startTime", "startTimeLocal", "endTime", "endTimeLocal", "timezoneId", "cutoffTime", "cutoffTimeLocal", "rrule", "exceptionDates", "allowedTags", "leadTimeMinutes", "priceCents", "minimumOrderValueCents", "maximumCapacity", "storeLocationId", "zoneId", "zoneExternalId", "windowMetadata", "isActive", "isDeleted" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the delivery window.", "example": "dw_01234567890123456789" }, "name": { "title": "Name", "type": "string", "description": "The name of the delivery window.", "example": "Monday Delivery Window" }, "startTime": { "title": "Starttime", "type": "string", "description": "The start time of the delivery window.", "example": "2024-01-01T10:00:00Z" }, "startTimeLocal": { "title": "Starttimelocal", "type": "string", "description": "The start time of the delivery window in local timezone.", "example": "2024-01-01T10:00:00" }, "endTime": { "title": "Endtime", "type": "string", "description": "The end time of the delivery window.", "example": "2024-01-01T12:00:00Z" }, "endTimeLocal": { "title": "Endtimelocal", "type": "string", "description": "The end time of the delivery window in local timezone.", "example": "2024-01-01T12:00:00" }, "timezoneId": { "title": "Timezoneid", "type": "string", "description": "The timezone id of the delivery window.", "example": "America/New_York" }, "cutoffTime": { "title": "Cutofftime", "type": "string", "description": "The cutoff time of the delivery window.", "example": "2024-01-01T10:00:00Z" }, "cutoffTimeLocal": { "title": "Cutofftimelocal", "type": "string", "description": "The cutoff time of the delivery window in local timezone.", "example": "2024-01-01T10:00:00" }, "rrule": { "title": "Rrule", "type": "string", "description": "The rrule of the delivery window.", "example": "RRULE:FREQ=WEEKLY;BYDAY=MO" }, "exceptionDates": { "title": "Exceptiondates", "type": "array", "items": { "type": "string" }, "description": "The exception dates of the delivery window.", "example": [ "2024-01-01", "2024-01-02" ] }, "allowedTags": { "title": "Allowedtags", "type": "array", "items": { "type": "string" }, "description": "The allowed tags of the delivery window.", "example": [ "service:rapid", "service:express", "franchise_location" ] }, "leadTimeMinutes": { "title": "Leadtimeminutes", "type": "integer", "description": "The lead time of the delivery window.", "example": 60 }, "priceCents": { "title": "Pricecents", "type": "integer", "description": "The price of the delivery window.", "example": 1000 }, "minimumOrderValueCents": { "title": "Minimumordervaluecents", "type": "integer", "description": "The minimum order value of the delivery window.", "example": 1000 }, "maximumCapacity": { "title": "Maximumcapacity", "type": "integer", "description": "The maximum capacity of the delivery window.", "example": 1000 }, "storeLocationId": { "title": "Storelocationid", "type": "string", "description": "The store location id of the delivery window.", "example": "stl_01234567890123456789" }, "zoneId": { "title": "Zoneid", "type": "string", "description": "The zone id of the delivery window.", "example": "zone_01234567890123456789" }, "zoneExternalId": { "title": "Zoneexternalid", "type": "string", "description": "The external zone id of the delivery window.", "example": "ext_01234567890123456789" }, "windowMetadata": { "title": "Windowmetadata", "type": "object", "additionalProperties": true, "description": "The metadata of the delivery window.", "example": { "key": "value" } }, "isActive": { "title": "Isactive", "type": "boolean", "description": "Whether the delivery window is active.", "example": true }, "isDeleted": { "title": "Isdeleted", "type": "boolean", "description": "Whether the delivery window is deleted.", "example": false } }, "description": "Response for a delivery window." }, "DeliveryWindowsOperationInputSerializer": { "title": "DeliveryWindowsOperationInputSerializer", "required": [ "ids" ], "type": "object", "properties": { "ids": { "title": "Ids", "type": "array", "items": { "type": "string" } } }, "description": "Expected payload for deleting multiple delivery windows." }, "DeliveryWindowsResponse": { "title": "DeliveryWindowsResponse", "required": [ "deliveryWindows" ], "type": "object", "properties": { "deliveryWindows": { "title": "Deliverywindows", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryWindowOutput" } } } }, "DenyList": { "title": "DenyList", "required": [ "id", "type", "value" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the deny list." }, "type": { "title": "Type", "type": "string", "description": "The type of the deny list." }, "value": { "title": "Value", "type": "string", "description": "The value of the deny list." } }, "description": "Representation of a Nash deny list." }, "DenyListResponse": { "title": "DenyListResponse", "type": "array", "items": { "$ref": "#/components/schemas/DenyList" }, "description": "Representation of a deny list response." }, "DetailsInputSerializer": { "title": "DetailsInputSerializer", "type": "object", "properties": { "weightedItemInfo": { "anyOf": [ { "$ref": "#/components/schemas/WeightedItemInfoInputSerializer" }, { "type": "null" } ], "description": "Weight information per item", "default": null }, "sizeSpecification": { "anyOf": [ { "$ref": "#/components/schemas/SizeSpecificationInputSerializer" }, { "type": "null" } ], "description": "Size specification details", "default": null }, "packSizeSpecification": { "anyOf": [ { "$ref": "#/components/schemas/PackSizeSpecificationInputSerializer" }, { "type": "null" } ], "description": "Pack size specification details", "default": null }, "skillsRequired": { "title": "Skillsrequired", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Skills required for handling this product", "default": null, "example": [ "gas_oven_installation" ] }, "dropoffServiceTimeSeconds": { "title": "Dropoffservicetimeseconds", "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "description": "Service time in seconds for handling this product at the dropoff (e.g. install, setup)", "default": null, "example": 600 } } }, "DetailsOutputSerializer": { "title": "DetailsOutputSerializer", "type": "object", "properties": { "weightedItemInfo": { "anyOf": [ { "$ref": "#/components/schemas/WeightedItemInfoOutputSerializer" }, { "type": "null" } ], "description": "Weight information per item", "default": null }, "sizeSpecification": { "anyOf": [ { "$ref": "#/components/schemas/SizeSpecificationOutputSerializer" }, { "type": "null" } ], "description": "Size specification details", "default": null }, "packSizeSpecification": { "anyOf": [ { "$ref": "#/components/schemas/PackSizeSpecificationOutputSerializer" }, { "type": "null" } ], "description": "Pack size specification details", "default": null } } }, "DetectDropoffAnomalyInputSerializer": { "title": "DetectDropoffAnomalyInputSerializer", "required": [ "deliveryId" ], "type": "object", "properties": { "deliveryId": { "title": "Deliveryid", "type": "string", "description": "The delivery to analyse for dropoff anomalies." } } }, "DimensionInputSerializer": { "title": "DimensionInputSerializer", "type": "object", "properties": { "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The depth dimension of the product", "default": null, "example": 10.5 }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The width dimension of the product", "default": null, "example": 5.0 }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The height dimension of the product", "default": null, "example": 15.2 } } }, "DimensionOutputSerializer": { "title": "DimensionOutputSerializer", "type": "object", "properties": { "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The depth dimension of the product", "default": null, "example": 10.5 }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The width dimension of the product", "default": null, "example": 5.0 }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The height dimension of the product", "default": null, "example": 15.2 } } }, "Dimensions": { "title": "Dimensions", "type": "object", "properties": { "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The height of the item in centimeters (cm)", "default": null, "example": 10 }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The width of the item in centimeters (cm)", "default": null, "example": 12 }, "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The depth of the item in centimeters (cm)", "default": null, "example": 14 } } }, "DispatchAndManifestInputSerializer": { "title": "DispatchAndManifestInputSerializer", "required": [ "orders" ], "type": "object", "properties": { "orders": { "title": "Orders", "type": "array", "items": { "$ref": "#/components/schemas/ManifestOrderInput" }, "description": "Orders to create, dispatch, and manifest." } }, "description": "Create, dispatch, and manifest orders in a single request." }, "DispatchAndManifestResponseSerializer": { "title": "DispatchAndManifestResponseSerializer", "required": [ "manifests" ], "type": "object", "properties": { "manifests": { "title": "Manifests", "type": "array", "items": { "$ref": "#/components/schemas/ManifestResultSerializer" }, "description": "Manifest results for orders that successfully created, dispatched, and manifested." }, "errors": { "title": "Errors", "type": "array", "items": { "$ref": "#/components/schemas/ManifestOrderErrorSerializer" }, "description": "Per-order failures encountered during create, dispatch, validate, or manifest." } } }, "DispatchOptimizationInputSerializer": { "title": "DispatchOptimizationInputSerializer", "type": "object", "properties": { "orderIds": { "title": "Orderids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Order IDs to dispatch. If omitted, all orders from the optimization are dispatched.", "default": null }, "autoDispatch": { "title": "Autodispatch", "type": "boolean", "description": "Automatically dispatch to provider (default: true)", "default": true } }, "description": "Input for dispatching optimized orders." }, "DispatchPlanList": { "title": "DispatchPlanList", "required": [ "plans", "nextCursor" ], "type": "object", "properties": { "plans": { "title": "Plans", "type": "array", "items": { "$ref": "#/components/schemas/DispatchPlanSummary" } }, "nextCursor": { "title": "Nextcursor", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "DispatchPlanOptimization": { "title": "DispatchPlanOptimization", "required": [ "status", "error" ], "type": "object", "properties": { "status": { "title": "Status", "enum": [ "queued", "running", "succeeded", "failed" ], "type": "string", "description": "`queued` and `running` are still working; `succeeded` and `failed` are final. `succeeded` means the run finished: take it. Take can still refuse it with reason `not_takeable`, which is final for that run." }, "error": { "title": "Error", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why a `failed` run failed, when it recorded a reason." } } }, "DispatchPlanOptimizationParams": { "title": "DispatchPlanOptimizationParams", "type": "object", "properties": { "outOfServiceRouteIds": { "title": "Outofservicerouteids", "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "Draft routes whose truck is out: their orders go to the other trucks." } }, "additionalProperties": false }, "DispatchPlanOptimizationStarted": { "title": "DispatchPlanOptimizationStarted", "required": [ "activityId" ], "type": "object", "properties": { "activityId": { "title": "Activityid", "type": "string", "description": "Poll it until it is `succeeded` or `failed`, and take a `succeeded` one." } } }, "DispatchPlanOptimizationTaken": { "title": "DispatchPlanOptimizationTaken", "required": [ "revision" ], "type": "object", "properties": { "revision": { "title": "Revision", "type": "integer", "description": "The plan's revision with the result taken in." } } }, "DispatchPlanSelection": { "title": "DispatchPlanSelection", "type": "object", "anyOf": [ { "required": [ "orderIds" ], "properties": { "orderIds": { "minItems": 1 } } }, { "required": [ "draftRouteIds" ], "properties": { "draftRouteIds": { "minItems": 1 } } } ], "properties": { "orderIds": { "title": "Orderids", "type": "array", "items": { "minLength": 1, "type": "string" } }, "draftRouteIds": { "title": "Draftrouteids", "type": "array", "items": { "minLength": 1, "type": "string" } } }, "additionalProperties": false }, "DispatchPlanSummary": { "title": "DispatchPlanSummary", "required": [ "id", "name", "source", "startDate", "endDate", "timezoneId", "zoneIds", "draftRevision", "draftContentHash", "restoreVersionNumber", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "tags": { "title": "Tags", "type": "array", "items": { "type": "string" } }, "source": { "title": "Source", "enum": [ "orders", "routes", "snapshot" ], "type": "string" }, "startDate": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ] }, "endDate": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ] }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zoneIds": { "title": "Zoneids", "type": "array", "items": { "type": "string" } }, "draftRevision": { "title": "Draftrevision", "type": "integer" }, "draftContentHash": { "title": "Draftcontenthash", "type": "string" }, "restoreVersionNumber": { "title": "Restoreversionnumber", "type": "integer" }, "createdAt": { "title": "Createdat", "type": "string", "format": "date-time" }, "updatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } }, "DispatchPlanTransfer": { "title": "DispatchPlanTransfer", "required": [ "transferId", "orderId", "sourceEpisodeId", "destinationEpisodeId", "transferredAt" ], "type": "object", "properties": { "transferId": { "title": "Transferid", "type": "string" }, "orderId": { "title": "Orderid", "type": "string" }, "sourceEpisodeId": { "title": "Sourceepisodeid", "type": "string" }, "destinationEpisodeId": { "title": "Destinationepisodeid", "type": "string" }, "transferredAt": { "title": "Transferredat", "type": "string", "format": "date-time" } } }, "DispatchPlanTransferDestination": { "title": "DispatchPlanTransferDestination", "required": [ "planId", "revision", "contentHash", "activeMemberCount", "name" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "contentHash": { "title": "Contenthash", "type": "string" }, "activeMemberCount": { "title": "Activemembercount", "type": "integer" }, "name": { "title": "Name", "type": "string" } } }, "DispatchPlanWrite": { "title": "DispatchPlanWrite", "required": [ "expectedRevision" ], "type": "object", "properties": { "expectedRevision": { "title": "Expectedrevision", "minimum": 0.0, "type": "integer", "description": "The `revision` of the plan you last read." } }, "additionalProperties": false }, "DispatchPlanWriteResult": { "title": "DispatchPlanWriteResult", "required": [ "planId", "revision", "contentHash", "restoreVersionNumber" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "contentHash": { "title": "Contenthash", "type": "string" }, "restoreVersionNumber": { "title": "Restoreversionnumber", "type": "integer", "description": "The saved version that Discard returns the plan to." } } }, "DispatchQuoteInput": { "title": "DispatchQuoteInput", "required": [ "providerId", "totalPriceCents" ], "type": "object", "properties": { "providerId": { "title": "Providerid", "type": "string" }, "totalPriceCents": { "title": "Totalpricecents", "type": "integer" } } }, "DispatchRoutesInputSerializer": { "title": "DispatchRoutesInputSerializer", "required": [ "routeIds" ], "type": "object", "properties": { "routeIds": { "title": "Routeids", "type": "array", "items": { "type": "string" }, "description": "Route IDs (internal or external) to dispatch" }, "autoDispatch": { "title": "Autodispatch", "type": "boolean", "description": "Automatically dispatch to provider (default: true)", "default": true } }, "description": "Input for dispatching routes to jobs." }, "DispatchRoutesOutputSerializer": { "title": "DispatchRoutesOutputSerializer", "required": [ "jobs" ], "type": "object", "properties": { "jobs": { "title": "Jobs", "type": "array", "items": { "$ref": "#/components/schemas/DispatchedJobSerializer" }, "description": "Jobs created from the dispatched routes." } }, "description": "Response payload for dispatching routes." }, "DispatchRuleContextInput": { "title": "DispatchRuleContextInput", "type": "object", "properties": { "packageValueCents": { "title": "Packagevaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "pickupTime": { "title": "Pickuptime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffTime": { "title": "Dropofftime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "drivingDistance": { "title": "Drivingdistance", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "metadata": { "title": "Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageHeight": { "title": "Packageheight", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "packageWidth": { "title": "Packagewidth", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "packageDepth": { "title": "Packagedepth", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "packageWeight": { "title": "Packageweight", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "totalWeight": { "title": "Totalweight", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "packageRequirements": { "title": "Packagerequirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "packageDeliveryMode": { "title": "Packagedeliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageTipCents": { "title": "Packagetipcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "numberOfPackages": { "title": "Numberofpackages", "type": "integer", "default": 1 }, "isBatch": { "title": "Isbatch", "type": "boolean", "default": false } } }, "DispatchRuleResult": { "title": "DispatchRuleResult", "type": "object", "properties": { "matchedRuleId": { "title": "Matchedruleid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "matchedRuleLabel": { "title": "Matchedrulelabel", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "matchedRuleCondition": { "title": "Matchedrulecondition", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "optionsGroupId": { "title": "Optionsgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "optionsGroupLabel": { "title": "Optionsgrouplabel", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "DispatchedJobSerializer": { "title": "DispatchedJobSerializer", "required": [ "id", "portalUrl" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The job id." }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "URL to view the job in the portal." } } }, "DocumentSerializer": { "title": "DocumentSerializer", "required": [ "createdAt", "id", "type", "contentType" ], "type": "object", "properties": { "createdAt": { "title": "Createdat", "type": "string" }, "id": { "title": "Id", "type": "string" }, "type": { "title": "Type", "type": "string" }, "url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "data": { "title": "Data", "anyOf": [ { "type": "string", "format": "binary" }, { "type": "null" } ], "default": null }, "contentType": { "title": "Contenttype", "type": "string" }, "documentMetadata": { "title": "Documentmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null } }, "description": "Generic serializer for Nash documents; Used for output." }, "DocumentType": { "title": "DocumentType", "enum": [ "shipping_label", "pickup_label", "manifest", "packing_slip_label", "proof_of_delivery" ], "type": "string" }, "DriverClocks": { "title": "DriverClocks", "required": [ "driver_id", "as_of", "status", "drive_remaining_minutes", "shift_remaining_minutes", "cycle_remaining_minutes" ], "type": "object", "properties": { "driver_id": { "title": "Driver Id", "minLength": 1, "type": "string" }, "as_of": { "title": "As Of", "type": "string", "format": "date-time" }, "status": { "title": "Status", "enum": [ "off_duty", "sleeper", "on_duty", "driving" ], "type": "string" }, "drive_remaining_minutes": { "title": "Drive Remaining Minutes", "maximum": 660, "minimum": 0.0, "type": "number" }, "shift_remaining_minutes": { "title": "Shift Remaining Minutes", "maximum": 840, "minimum": 0.0, "type": "number" }, "break_remaining_minutes": { "title": "Break Remaining Minutes", "maximum": 480, "minimum": 0.0, "type": "number", "default": 480 }, "cycle_remaining_minutes": { "title": "Cycle Remaining Minutes", "maximum": 4200, "minimum": 0.0, "type": "number" }, "cycle_by_day": { "title": "Cycle By Day", "anyOf": [ { "maxItems": 8, "type": "array", "items": { "type": "number" } }, { "type": "null" } ], "default": null }, "off_duty_since": { "title": "Off Duty Since", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "available_from": { "title": "Available From", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } }, "additionalProperties": false, "description": "A driver's hours-of-service state at `as_of`, as an ELD or a dispatcher reports it." }, "DriverGeolocationGreaterThanParams": { "title": "DriverGeolocationGreaterThanParams", "required": [ "metricValue", "deliveryStatus", "location" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number", "description": "Numeric threshold for the condition." }, "deliveryStatus": { "title": "Deliverystatus", "minLength": 1, "type": "string", "description": "Delivery status this rule applies to." }, "hasCancellationReason": { "title": "Hascancellationreason", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "firstTaskOnly": { "title": "Firsttaskonly", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "statusHistoryIncludes": { "title": "Statushistoryincludes", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "statusHistoryDoesNotInclude": { "title": "Statushistorydoesnotinclude", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "condition": { "title": "Condition", "type": "string", "default": "greater_than", "const": "greater_than" }, "metricName": { "title": "Metricname", "enum": [ "minutes", "miles", "kilometers" ], "type": "string", "default": "minutes" }, "location": { "title": "Location", "enum": [ "pickup_location", "dropoff_location" ], "type": "string" } } }, "DriverGeolocationStoppedForParams": { "title": "DriverGeolocationStoppedForParams", "required": [ "metricValue", "deliveryStatus" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number", "description": "Numeric threshold for the condition." }, "deliveryStatus": { "title": "Deliverystatus", "minLength": 1, "type": "string", "description": "Delivery status this rule applies to." }, "hasCancellationReason": { "title": "Hascancellationreason", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "firstTaskOnly": { "title": "Firsttaskonly", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "statusHistoryIncludes": { "title": "Statushistoryincludes", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "statusHistoryDoesNotInclude": { "title": "Statushistorydoesnotinclude", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "condition": { "title": "Condition", "type": "string", "default": "stopped_for", "const": "stopped_for" }, "metricName": { "title": "Metricname", "type": "string", "default": "minutes", "const": "minutes" } } }, "DriverGeolocationWithinParams": { "title": "DriverGeolocationWithinParams", "required": [ "metricValue", "deliveryStatus", "location" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number", "description": "Numeric threshold for the condition." }, "deliveryStatus": { "title": "Deliverystatus", "minLength": 1, "type": "string", "description": "Delivery status this rule applies to." }, "hasCancellationReason": { "title": "Hascancellationreason", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "firstTaskOnly": { "title": "Firsttaskonly", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "statusHistoryIncludes": { "title": "Statushistoryincludes", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "statusHistoryDoesNotInclude": { "title": "Statushistorydoesnotinclude", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "condition": { "title": "Condition", "type": "string", "default": "within", "const": "within" }, "metricName": { "title": "Metricname", "enum": [ "minutes", "miles", "kilometers" ], "type": "string", "default": "minutes" }, "location": { "title": "Location", "enum": [ "pickup_location", "dropoff_location" ], "type": "string" } } }, "DriverGroupMember": { "title": "DriverGroupMember", "required": [ "id", "enabled", "isShiftActive" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "enabled": { "title": "Enabled", "type": "boolean" }, "isShiftActive": { "title": "Isshiftactive", "type": "boolean" } } }, "DriverGroupRead": { "title": "DriverGroupRead", "required": [ "firstVersionContractId", "displayName", "isActive", "providerId" ], "type": "object", "properties": { "firstVersionContractId": { "title": "Firstversioncontractid", "type": "string", "description": "Stable id of the driver group across versions." }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "displayName": { "title": "Displayname", "type": "string" }, "isActive": { "title": "Isactive", "type": "boolean" }, "unassignedDriverTimeoutMinutes": { "title": "Unassigneddrivertimeoutminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "providerId": { "title": "Providerid", "type": "string" } } }, "DriverGroupReadDetailed": { "title": "DriverGroupReadDetailed", "required": [ "firstVersionContractId", "displayName", "isActive", "providerId", "drivers" ], "type": "object", "properties": { "firstVersionContractId": { "title": "Firstversioncontractid", "type": "string", "description": "Stable id of the driver group across versions." }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "displayName": { "title": "Displayname", "type": "string" }, "isActive": { "title": "Isactive", "type": "boolean" }, "unassignedDriverTimeoutMinutes": { "title": "Unassigneddrivertimeoutminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "providerId": { "title": "Providerid", "type": "string" }, "drivers": { "title": "Drivers", "type": "array", "items": { "$ref": "#/components/schemas/DriverGroupMember" }, "description": "Drivers of your organization in this group." } } }, "DriverGroupSerializer": { "title": "DriverGroupSerializer", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "description": "Driver group details for a route." }, "DriverGroupUpsert": { "title": "DriverGroupUpsert", "required": [ "externalIdentifier" ], "type": "object", "properties": { "externalIdentifier": { "title": "Externalidentifier", "minLength": 1, "type": "string", "description": "Your own id for this group; the upsert key." }, "displayName": { "title": "Displayname", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Required when the group is created.", "default": null }, "isActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Defaults to true for a new group. Set false to disable a group.", "default": null }, "unassignedDriverTimeoutMinutes": { "title": "Unassigneddrivertimeoutminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "driverIds": { "title": "Driverids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Full list of your drivers in this group. Omit to leave membership unchanged; send [] to remove all.", "default": null } }, "additionalProperties": false, "description": "``PUT /v1/fleet/driver-groups/upsert`` request body.\n\nKeyed on ``external_identifier`` within the calling org's own internal fleet. Omitted fields\nare left unchanged; an explicit null ``unassigned_driver_timeout_minutes`` clears it." }, "DriverGroupUpsertResponse": { "title": "DriverGroupUpsertResponse", "required": [ "firstVersionContractId", "displayName", "isActive", "providerId", "drivers", "created" ], "type": "object", "properties": { "firstVersionContractId": { "title": "Firstversioncontractid", "type": "string", "description": "Stable id of the driver group across versions." }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "displayName": { "title": "Displayname", "type": "string" }, "isActive": { "title": "Isactive", "type": "boolean" }, "unassignedDriverTimeoutMinutes": { "title": "Unassigneddrivertimeoutminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "providerId": { "title": "Providerid", "type": "string" }, "drivers": { "title": "Drivers", "type": "array", "items": { "$ref": "#/components/schemas/DriverGroupMember" }, "description": "Drivers of your organization in this group." }, "created": { "title": "Created", "type": "boolean" } } }, "DriverLocationVsDeliveryStatusParams": { "title": "DriverLocationVsDeliveryStatusParams", "required": [ "metricValue", "deliveryStatus" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" }, "metricName": { "title": "Metricname", "type": "string", "default": "miles", "const": "miles" }, "deliveryStatus": { "title": "Deliverystatus", "minLength": 1, "type": "string" } } }, "DriverStackingParams": { "title": "DriverStackingParams", "type": "object", "properties": { "annotateAllDeliveries": { "title": "Annotatealldeliveries", "type": "boolean", "default": false }, "matchCourierAcrossProviders": { "title": "Matchcourieracrossproviders", "type": "boolean", "default": false } } }, "DropoffDelayedParams": { "title": "DropoffDelayedParams", "required": [ "metricValue" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" }, "metricName": { "title": "Metricname", "type": "string", "default": "minutes", "const": "minutes" } } }, "DroppedOrder": { "title": "DroppedOrder", "required": [ "order_id", "leg_ids", "reasons", "detail_codes", "previous_state", "causes", "primary_cause" ], "type": "object", "properties": { "order_id": { "title": "Order Id", "type": "string" }, "leg_ids": { "title": "Leg Ids", "type": "array", "items": { "type": "string" } }, "reasons": { "title": "Reasons", "type": "array", "items": { "type": "string" } }, "detail_codes": { "title": "Detail Codes", "type": "array", "items": { "type": "integer" } }, "nash_diagnosis": { "anyOf": [ { "$ref": "#/components/schemas/JsonValue" }, { "type": "null" } ], "default": null }, "previous_state": { "anyOf": [ { "$ref": "#/components/schemas/PreviousState" }, { "type": "null" } ] }, "causes": { "title": "Causes", "type": "array", "items": { "$ref": "#/components/schemas/UnassignedCause" } }, "primary_cause": { "anyOf": [ { "$ref": "#/components/schemas/UnassignedCause" }, { "type": "null" } ] } } }, "DspParams": { "title": "DspParams", "type": "object", "properties": { "timezone": { "title": "Timezone", "type": "string", "default": "America/Indiana/Indianapolis" }, "speed_table": { "title": "Speed Table", "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SpeedBand" } }, "departure_grid_minutes": { "title": "Departure Grid Minutes", "maximum": 240, "minimum": 5.0, "type": "integer", "default": 30 }, "earliest_departure": { "anyOf": [ { "$ref": "#/components/schemas/DayTime" }, { "type": "null" } ], "default": null }, "latest_departure": { "anyOf": [ { "$ref": "#/components/schemas/DayTime" }, { "type": "null" } ], "default": null }, "service_minutes": { "title": "Service Minutes", "minimum": 0.0, "type": "number", "description": "Default unload duration; explicitly setting this on a dry run overrides per-order service times", "default": 50 }, "pretrip_minutes": { "title": "Pretrip Minutes", "minimum": 0.0, "type": "number", "default": 15 }, "posttrip_minutes": { "title": "Posttrip Minutes", "minimum": 0.0, "type": "number", "default": 15 }, "turn_minutes": { "title": "Turn Minutes", "minimum": 0.0, "type": "number", "default": 30 }, "stop_pay_per_hour": { "title": "Stop Pay Per Hour", "minimum": 0.0, "type": "number", "default": 20 }, "fairness_weight": { "title": "Fairness Weight", "minimum": 0.0, "type": "number", "default": 5 }, "fairness_week_start": { "title": "Fairness Week Start", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string", "default": "sunday" }, "span_cost_per_hour": { "title": "Span Cost Per Hour", "minimum": 0.0, "type": "number", "default": 1 }, "max_pairs_per_load": { "title": "Max Pairs Per Load", "maximum": 50, "minimum": 0.0, "type": "integer", "default": 8 }, "unload_counts_as_break": { "title": "Unload Counts As Break", "type": "boolean", "default": true }, "mip_gap": { "title": "Mip Gap", "maximum": 0.5, "minimum": 0.0, "type": "number", "default": 0.002 }, "time_limit_seconds": { "title": "Time Limit Seconds", "maximum": 600, "exclusiveMinimum": 0.0, "type": "number", "default": 120 } }, "additionalProperties": false }, "DynamicCadenceConfigInputSerializer": { "title": "DynamicCadenceConfigInputSerializer", "required": [ "tiersBeforeCutoff" ], "type": "object", "properties": { "tiersBeforeCutoff": { "title": "Tiersbeforecutoff", "type": "array", "items": { "$ref": "#/components/schemas/CadenceTierInputSerializer" } } } }, "EligibleDeliveryWindow": { "title": "EligibleDeliveryWindow", "required": [ "id", "ineligibleReason", "allowedTags", "startTime", "startTimeLocal", "endTime", "endTimeLocal" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The id of the delivery window" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the delivery window", "default": null, "example": "S21" }, "ineligibleReason": { "title": "Ineligiblereason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ineligibility failure reason", "example": "Ineligible due to order tags" }, "allowedTags": { "title": "Allowedtags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The list of allowed tags", "example": "['rapid', 'oversize']" }, "storeLocationId": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the store location object", "default": null, "example": "stl_1234567890" }, "storeLocationExternalId": { "title": "Storelocationexternalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the store location object, if applicable", "default": null, "example": "1001" }, "zoneId": { "title": "Zoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the zone object", "default": null, "example": "zone_1234567890" }, "zoneExternalId": { "title": "Zoneexternalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the zone object, if applicable", "default": null, "example": "1001" }, "cutoffTime": { "title": "Cutofftime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The cutoff time of the delivery window in UTC", "example": "2024-10-04T00:00:00.000000" }, "cutoffTimeLocal": { "title": "Cutofftimelocal", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The cutoff time of the delivery window in local timezone", "example": "2024-10-04T00:00:00.000000" }, "startTime": { "title": "Starttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the delivery window in UTC", "example": "2024-10-06T00:00:00.000000" }, "startTimeLocal": { "title": "Starttimelocal", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the delivery window in local timezone", "example": "2024-10-06T00:00:00.000000" }, "endTime": { "title": "Endtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the delivery window in UTC", "example": "2024-10-07T00:00:00.000000" }, "endTimeLocal": { "title": "Endtimelocal", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the delivery window in local timezone", "example": "2024-10-07T00:00:00.000000" }, "remainingCapacity": { "title": "Remainingcapacity", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The remaining capacity for the delivery window", "default": null, "example": 10.0 }, "maximumCapacity": { "title": "Maximumcapacity", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The maximum capacity for the delivery window", "default": null, "example": 10.0 }, "minimumOrderValueCents": { "title": "Minimumordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The minimum order value for the delivery window in cents", "default": null, "example": 1000 }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The timezone id of the return timestamps, following the TZ database format", "default": null, "example": "America/New_York" }, "priceCents": { "title": "Pricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price for the delivery window in cents", "default": null, "example": 1000 }, "score": { "title": "Score", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The score for the delivery window", "default": null, "example": 1.0 }, "windowMetadata": { "title": "Windowmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value window metadata.", "default": null, "example": { "key": "value" } } } }, "EligibleDeliveryWindowsResponse": { "title": "EligibleDeliveryWindowsResponse", "required": [ "eligibleDeliveryWindows", "ineligibleDeliveryWindows" ], "type": "object", "properties": { "eligibleDeliveryWindows": { "title": "Eligibledeliverywindows", "type": "array", "items": { "$ref": "#/components/schemas/EligibleDeliveryWindow" } }, "ineligibleDeliveryWindows": { "title": "Ineligibledeliverywindows", "type": "array", "items": { "$ref": "#/components/schemas/EligibleDeliveryWindow" } } }, "description": "Response for the eligible delivery windows endpoint." }, "EmbedSessionEnvelope": { "title": "EmbedSessionEnvelope", "required": [ "client_secret", "expires_at", "session_id", "api_region" ], "type": "object", "properties": { "client_secret": { "title": "Client Secret", "type": "string", "description": "Browser-held session secret (`wcs_\u2026`). Shown once, never retrievable." }, "expires_at": { "title": "Expires At", "type": "string", "format": "date-time" }, "session_id": { "title": "Session Id", "type": "string" }, "api_region": { "title": "Api Region", "type": "string" } }, "description": "The mint response, and the entire browser contract (PLAT-22260).\n\nThe host backend forwards this verbatim to its page; it is not expected to\nadd, rename, or reshape anything. Four fields, each earning its place:\n\n* `client_secret` \u2014 the only value that authenticates the browser.\n* `expires_at` \u2014 so the page can refresh *before* a request fails rather\n than discovering expiry as a broken widget.\n* `session_id` \u2014 non-secret. The browser's cache key and the id that shows\n up in logs and support tickets, which is exactly why it is separate from\n the secret rather than derived from it.\n* `api_region` \u2014 which Nash API the widget bundle should talk to, as one\n of the published wire tokens the widget loader accepts: `\"us\"` or\n `\"au\"`. Never a deployment region string like `us-west-1` \u2014 the browser\n resolves this against its own build-time endpoint table, not against\n server config (see `embed_session_service.resolve_api_region`)." }, "EmbedSessionMintRequest": { "title": "EmbedSessionMintRequest", "required": [ "widget", "scopes", "resources", "parent_origin" ], "type": "object", "properties": { "widget": { "title": "Widget", "maxLength": 64, "minLength": 1, "type": "string", "description": "Widget identifier, e.g. `live_map` (`live-map` is accepted)." }, "scopes": { "title": "Scopes", "maxItems": 8, "minItems": 1, "type": "array", "items": { "maxLength": 64, "minLength": 1, "type": "string" }, "description": "Scopes to grant, e.g. `['live_map:read']`. Must be granted for the widget." }, "resources": { "title": "Resources", "maxProperties": 4, "minProperties": 1, "type": "object", "additionalProperties": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "maxLength": 255, "minLength": 1, "type": "string" } }, "description": "The exact resources this session may read, e.g. `{'delivery_ids': ['del_1']}`." }, "parent_origin": { "title": "Parent Origin", "maxLength": 255, "minLength": 1, "type": "string", "description": "The page origin that will host the widget. Must match an allowed origin exactly." }, "ttl": { "title": "Ttl", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Requested lifetime in seconds. Defaults to 900.", "default": null }, "refresh_session_id": { "title": "Refresh Session Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Session id (`wes_\u2026`) to replace. The replacement may narrow the parent's scopes and resources or preserve them; it can never widen them. Omit for a fresh mint.", "default": null } }, "additionalProperties": false, "description": "Body of `POST /v1/embed-sessions`.\n\n`extra=\"forbid\"`: this endpoint mints an authorization capability, and the\none thing worse than rejecting a typo is accepting `scope` (singular) and\nquietly granting nothing." }, "EntityStatus": { "title": "EntityStatus", "enum": [ "archived", "arrived_at_facility", "assigned", "assigned_driver", "awaiting_consignee_pickup", "awaiting_consignor_dropoff", "canceled", "canceled_by_auto_reassign", "canceled_by_customer", "canceled_by_merchant", "canceled_by_nash", "canceled_by_provider", "canceled_by_reassign", "completed", "confirmed", "contacting_provider", "created", "delayed", "departed_from_facility", "dispatch_failure", "dispatched", "dispatched_to_provider", "dropoff_arrived", "dropoff_complete", "dropoff_enroute", "expired", "failed", "in_progress", "in_transit", "items_pick_complete", "label_created", "manifested", "needs_attention", "not_assigned_driver", "partial_delivered", "pick_complete", "picking_complete", "pickup_arrived", "pickup_complete", "pickup_enroute", "pickup_in_progress", "planned_selection", "return_arrived", "return_in_progress", "returned", "returned_to_store", "running", "scheduled", "sent_to_provider", "started", "valid" ], "type": "string" }, "EvaluateDispatchInput": { "title": "EvaluateDispatchInput", "required": [ "quotes" ], "type": "object", "properties": { "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full pickup address in one line. Will be geocoded to lat/lng if pickupLat/pickupLng not provided.", "default": null }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name.", "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full dropoff address in one line. Will be geocoded to lat/lng if dropoffLat/dropoffLng not provided.", "default": null }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff business name.", "default": null }, "quotes": { "title": "Quotes", "type": "array", "items": { "$ref": "#/components/schemas/DispatchQuoteInput" } }, "context": { "anyOf": [ { "$ref": "#/components/schemas/DispatchRuleContextInput" }, { "type": "null" } ], "default": null }, "optionsGroupId": { "title": "Optionsgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "If provided, skip dispatch rule evaluation and use this options group directly.", "default": null } } }, "EvaluateDispatchOutput": { "title": "EvaluateDispatchOutput", "required": [ "rankedProviders" ], "type": "object", "properties": { "dispatchRule": { "anyOf": [ { "$ref": "#/components/schemas/DispatchRuleResult" }, { "type": "null" } ], "default": null }, "rankedProviders": { "title": "Rankedproviders", "type": "array", "items": { "$ref": "#/components/schemas/RankedProvider" } }, "strategy": { "title": "Strategy", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "EventOutputPayload": { "title": "EventOutputPayload", "required": [ "id", "eventName", "orderId", "eventCreatedAt" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "eventName": { "title": "Eventname", "type": "string" }, "orderId": { "title": "Orderid", "type": "string" }, "payload": { "title": "Payload", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "eventCreatedAt": { "title": "Eventcreatedat", "type": "string" } } }, "Fallback": { "title": "Fallback", "required": [ "name", "unit" ], "type": "object", "properties": { "name": { "title": "Name", "maxLength": 64, "minLength": 1, "type": "string" }, "unit": { "title": "Unit", "enum": [ "duty", "load" ], "type": "string" }, "cost_per_use": { "title": "Cost Per Use", "minimum": 0.0, "type": "number", "default": 0 }, "cost_per_calendar_day": { "title": "Cost Per Calendar Day", "minimum": 0.0, "type": "number", "default": 0 }, "daily_cap": { "title": "Daily Cap", "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "default": null } }, "additionalProperties": false, "description": "Capacity that covers work instead of an own driver: a whole duty (support truck) or one load (carrier)." }, "FeedbackOutputSerializer": { "title": "FeedbackOutputSerializer", "required": [ "id", "deliveryId", "score" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Feedback ID" }, "deliveryId": { "title": "Deliveryid", "type": "string", "description": "Delivery ID" }, "score": { "title": "Score", "type": "number", "description": "Feedback score" }, "comment": { "title": "Comment", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Feedback comment", "default": null } } }, "FieldChange": { "title": "FieldChange", "required": [ "path" ], "type": "object", "properties": { "path": { "title": "Path", "type": "string" }, "before": { "$ref": "#/components/schemas/JsonValue", "default": null }, "after": { "$ref": "#/components/schemas/JsonValue", "default": null } }, "description": "One changed field. `path` is dotted, for example `service.dropoff_quantities`." }, "FilterCriterion": { "title": "FilterCriterion", "required": [ "field", "valueType" ], "type": "object", "properties": { "field": { "title": "Field", "type": "string", "description": "Wire field name on the create/update payload (e.g. 'optionsGroupIds')." }, "valueType": { "$ref": "#/components/schemas/FilterValueType", "description": "How the value is shaped." }, "listEndpoint": { "title": "Listendpoint", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Endpoint that lists valid ids, when value_type=id_list.", "default": null }, "operators": { "title": "Operators", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ConditionOperator" } }, { "type": "null" } ], "description": "Operators available, when value_type=condition_tree.", "default": null }, "nodeShape": { "title": "Nodeshape", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Condition-tree node shape, when value_type=condition_tree.", "default": null }, "description": { "title": "Description", "type": "string", "description": "What this filter limits.", "default": "" } }, "description": "A single filter criterion available to all notification triggers." }, "FilterCriterionKey": { "title": "FilterCriterionKey", "enum": [ "dispatch_strategies", "contracts", "zones", "metadata_conditions" ], "type": "string", "description": "The shared filter criteria a trigger can be scoped by." }, "FilterValueType": { "title": "FilterValueType", "enum": [ "id_list", "condition_tree" ], "type": "string", "description": "How a filter criterion's value is shaped." }, "FlagStatus": { "title": "FlagStatus", "enum": [ "NEEDS_ATTENTION", "ACKNOWLEDGED", "RESOLVED" ], "type": "string" }, "FleetPoint": { "title": "FleetPoint", "required": [ "activity_id", "completed_at", "vans", "order_slots" ], "type": "object", "properties": { "activity_id": { "title": "Activity Id", "type": "string" }, "completed_at": { "title": "Completed At", "type": "string", "format": "date-time" }, "vans": { "title": "Vans", "type": "integer" }, "order_slots": { "title": "Order Slots", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "description": "Van count and order slots of one applied run, for reading the fleet over the hours before the current run." }, "FleetProjection": { "title": "FleetProjection", "required": [ "organization_id", "store_location_id", "contracts", "digest" ], "type": "object", "properties": { "projection_version": { "title": "Projection Version", "type": "integer", "default": 2 }, "organization_id": { "title": "Organization Id", "type": "string" }, "store_location_id": { "title": "Store Location Id", "type": "string" }, "contracts": { "title": "Contracts", "type": "array", "items": { "$ref": "#/components/schemas/ProjectedContractFleet" } }, "digest": { "title": "Digest", "type": "string" } }, "description": "Digest covers this body except ``digest`` and each contract's ``requested_contract_ids``." }, "FleetProjectionRequest": { "title": "FleetProjectionRequest", "required": [ "store_location_id", "contract_ids" ], "type": "object", "properties": { "store_location_id": { "title": "Store Location Id", "minLength": 1, "type": "string" }, "contract_ids": { "title": "Contract Ids", "maxItems": 100, "minItems": 1, "type": "array", "items": { "maxLength": 255, "minLength": 1, "type": "string" } }, "shift_ids": { "title": "Shift Ids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "pick_shift_name": { "title": "Pick Shift Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "shift_contract_id": { "title": "Shift Contract Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "additionalProperties": false, "description": "Body for ``POST /v1/optimization/fleet-projection``.\n\n``store_location_id`` and ``contract_ids`` are the plain single-store solve. The three\nfleet-selection knobs are accepted only so a caller can hand over exactly what it intends to\nsend to the solver: any of them present moves the solver onto a Shift-built fleet, which this\nprojection does not cover, so the request is refused rather than projected wrongly." }, "FullJobPayload": { "title": "FullJobPayload", "required": [ "job" ], "type": "object", "properties": { "job": { "$ref": "#/components/schemas/ReturnedJobMixin" } }, "description": "Expected output from autodispatch job endpoint." }, "GetBulkOperationResponse": { "title": "GetBulkOperationResponse", "required": [ "status", "summary", "results" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ActivityStatus", "description": "The status of the bulk operation", "example": "SUCCESS" }, "summary": { "$ref": "#/components/schemas/BulkOperationSummary", "description": "The summary of the bulk operation", "example": { "failedOperations": 1, "successfulOperations": 4, "totalOperations": 5 } }, "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/BulkOperationResult" }, "description": "The results of the bulk operation", "example": [ { "action": "upsert", "errorMessage": null, "id": "ord_1234567890", "status": "success" }, { "action": "delete", "errorMessage": null, "id": "ord_0987654321", "status": "success" }, { "action": "delete", "errorMessage": "order with id or external_id 'ord_fake_does_not_exist' does not exist, error_code=MISSING_RESOURCE", "id": "ord_fake_does_not_exist", "status": "error" } ] } }, "description": "Bulk Operation Response for Orders." }, "HealthCheckResponse": { "title": "HealthCheckResponse", "enum": [ "TRUE", "FALSE" ], "type": "string" }, "HubLabel": { "title": "HubLabel", "required": [ "kind", "symbology", "barcode", "routeId", "zpl" ], "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/HubLabelKind" }, "symbology": { "title": "Symbology", "enum": [ "qr", "code128" ], "type": "string" }, "barcode": { "title": "Barcode", "type": "string" }, "routeId": { "title": "Routeid", "type": "string" }, "orderId": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "itemId": { "title": "Itemid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "stopNumber": { "title": "Stopnumber", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "zpl": { "title": "Zpl", "type": "string" } } }, "HubLabelKind": { "title": "HubLabelKind", "enum": [ "rack", "package" ], "type": "string" }, "HubLabelMedia": { "title": "HubLabelMedia", "type": "object", "properties": { "widthInches": { "title": "Widthinches", "type": "integer", "default": 4, "const": 4 }, "heightInches": { "title": "Heightinches", "type": "integer", "default": 2, "const": 2 }, "dpi": { "title": "Dpi", "type": "integer", "default": 203, "const": 203 } } }, "HubLabelPackageIdentity": { "title": "HubLabelPackageIdentity", "required": [ "orderId", "itemId" ], "type": "object", "properties": { "orderId": { "title": "Orderid", "maxLength": 128, "minLength": 1, "type": "string" }, "itemId": { "title": "Itemid", "maxLength": 128, "minLength": 1, "type": "string" } } }, "HubLabelRequest": { "title": "HubLabelRequest", "required": [ "manifestVersion", "kinds" ], "type": "object", "properties": { "manifestVersion": { "title": "Manifestversion", "maxLength": 64, "minLength": 64, "pattern": "^[0-9a-f]{64}$", "type": "string" }, "kinds": { "title": "Kinds", "maxItems": 2, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/HubLabelKind" } }, "packages": { "title": "Packages", "anyOf": [ { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/HubLabelPackageIdentity" } }, { "type": "null" } ], "default": null } } }, "HubLabelResponse": { "title": "HubLabelResponse", "required": [ "routeId", "manifestVersion", "templateVersion", "labels" ], "type": "object", "properties": { "routeId": { "title": "Routeid", "type": "string" }, "manifestVersion": { "title": "Manifestversion", "type": "string" }, "templateVersion": { "title": "Templateversion", "type": "string" }, "media": { "$ref": "#/components/schemas/HubLabelMedia" }, "labels": { "title": "Labels", "type": "array", "items": { "$ref": "#/components/schemas/HubLabel" } } } }, "HubOperation": { "title": "HubOperation", "enum": [ "receive", "report_damage", "clear_damage", "confirm_damage", "confirm_damage_donate", "mark_shortage", "reattempt", "mark_lost", "close_missing" ], "type": "string" }, "HubOrderHistory": { "title": "HubOrderHistory", "required": [ "eventId", "operation", "capturedAt", "receivedAt", "actorId" ], "type": "object", "properties": { "eventId": { "title": "Eventid", "type": "string", "format": "uuid" }, "operation": { "$ref": "#/components/schemas/HubOperation" }, "capturedAt": { "title": "Capturedat", "type": "string", "format": "date-time" }, "receivedAt": { "title": "Receivedat", "type": "string", "format": "date-time" }, "actorId": { "title": "Actorid", "type": "string" }, "reason": { "title": "Reason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "HubOrderOperationRequest": { "title": "HubOrderOperationRequest", "required": [ "eventId", "capturedAt", "deviceId", "operation", "expectedVersion" ], "type": "object", "properties": { "eventId": { "title": "Eventid", "type": "string", "format": "uuid" }, "capturedAt": { "title": "Capturedat", "type": "string", "format": "date-time" }, "deviceId": { "title": "Deviceid", "maxLength": 128, "minLength": 1, "type": "string" }, "reason": { "title": "Reason", "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null }, "operation": { "$ref": "#/components/schemas/HubOperation" }, "expectedVersion": { "title": "Expectedversion", "pattern": "^[0-9a-f]{64}$", "type": "string" } } }, "HubOrderRead": { "title": "HubOrderRead", "required": [ "orderId", "hubId", "serviceDate", "barcode", "version", "receiptStatus", "condition", "disposition" ], "type": "object", "properties": { "orderId": { "title": "Orderid", "type": "string" }, "hubId": { "title": "Hubid", "type": "string" }, "serviceDate": { "title": "Servicedate", "type": "string", "format": "date" }, "routeId": { "title": "Routeid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "barcode": { "title": "Barcode", "type": "string" }, "version": { "title": "Version", "type": "string" }, "receiptStatus": { "title": "Receiptstatus", "enum": [ "pending", "received", "shortage" ], "type": "string" }, "condition": { "title": "Condition", "enum": [ "not_assessed", "first_quality", "damage_pending", "damaged" ], "type": "string" }, "disposition": { "title": "Disposition", "enum": [ "active", "lost_in_hub", "closed", "donated" ], "type": "string" }, "receivedAt": { "title": "Receivedat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "receivedBy": { "title": "Receivedby", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "conditionReason": { "title": "Conditionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "staged": { "title": "Staged", "type": "boolean", "default": false }, "loaded": { "title": "Loaded", "type": "boolean", "default": false }, "actualRouteId": { "title": "Actualrouteid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "loadBlockedReason": { "title": "Loadblockedreason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "history": { "title": "History", "type": "array", "items": { "$ref": "#/components/schemas/HubOrderHistory" } }, "allowedOperations": { "title": "Allowedoperations", "type": "array", "items": { "$ref": "#/components/schemas/HubOperation" } } } }, "HubReceiptRequest": { "title": "HubReceiptRequest", "required": [ "eventId", "capturedAt", "deviceId", "barcode", "hubId", "serviceDate" ], "type": "object", "properties": { "eventId": { "title": "Eventid", "type": "string", "format": "uuid" }, "capturedAt": { "title": "Capturedat", "type": "string", "format": "date-time" }, "deviceId": { "title": "Deviceid", "maxLength": 128, "minLength": 1, "type": "string" }, "reason": { "title": "Reason", "anyOf": [ { "maxLength": 500, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null }, "barcode": { "title": "Barcode", "maxLength": 500, "minLength": 1, "type": "string" }, "hubId": { "title": "Hubid", "maxLength": 500, "minLength": 1, "type": "string" }, "serviceDate": { "title": "Servicedate", "type": "string", "format": "date" }, "condition": { "title": "Condition", "enum": [ "first_quality", "damage_pending" ], "type": "string", "default": "first_quality" } } }, "HubReceiptResult": { "title": "HubReceiptResult", "required": [ "eventId", "barcode", "outcome", "serverReceivedAt" ], "type": "object", "properties": { "eventId": { "title": "Eventid", "type": "string", "format": "uuid" }, "barcode": { "title": "Barcode", "type": "string" }, "outcome": { "title": "Outcome", "enum": [ "received", "already_received", "damage_reported", "unknown_barcode", "ambiguous_barcode", "on_hold" ], "type": "string" }, "order": { "anyOf": [ { "$ref": "#/components/schemas/HubOrderRead" }, { "type": "null" } ], "default": null }, "serverReceivedAt": { "title": "Serverreceivedat", "type": "string", "format": "date-time" }, "loadBlockedReason": { "title": "Loadblockedreason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "HubScanManifest": { "title": "HubScanManifest", "required": [ "routeId", "pickupStopId", "hubId", "serviceDate", "manifestVersion", "packages", "acceptedOrderIds", "acceptedCount", "expectedCount" ], "type": "object", "properties": { "routeId": { "title": "Routeid", "type": "string" }, "routeExternalId": { "title": "Routeexternalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "routeName": { "title": "Routename", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pickupStopId": { "title": "Pickupstopid", "type": "string" }, "hubId": { "title": "Hubid", "type": "string" }, "hubName": { "title": "Hubname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "serviceDate": { "title": "Servicedate", "type": "string", "format": "date" }, "manifestVersion": { "title": "Manifestversion", "type": "string" }, "packages": { "title": "Packages", "type": "array", "items": { "$ref": "#/components/schemas/HubScanPackage" } }, "acceptedOrderIds": { "title": "Acceptedorderids", "type": "array", "items": { "type": "string" } }, "acceptedCount": { "title": "Acceptedcount", "type": "integer" }, "expectedCount": { "title": "Expectedcount", "type": "integer" }, "operationsEnabled": { "title": "Operationsenabled", "type": "boolean", "default": true }, "receivedCount": { "title": "Receivedcount", "type": "integer", "default": 0 }, "exceptionCount": { "title": "Exceptioncount", "type": "integer", "default": 0 }, "readyCount": { "title": "Readycount", "type": "integer", "default": 0 }, "loadedCount": { "title": "Loadedcount", "type": "integer", "default": 0 } } }, "HubScanOutcome": { "title": "HubScanOutcome", "enum": [ "accepted", "already_staged", "wrong_route", "unknown_barcode", "ambiguous_barcode", "manifest_changed", "not_received", "on_hold" ], "type": "string" }, "HubScanPackage": { "title": "HubScanPackage", "required": [ "orderId", "itemId", "barcode", "staged" ], "type": "object", "properties": { "orderId": { "title": "Orderid", "type": "string" }, "itemId": { "title": "Itemid", "type": "string" }, "barcode": { "title": "Barcode", "type": "string" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "staged": { "title": "Staged", "type": "boolean" }, "receiptStatus": { "title": "Receiptstatus", "enum": [ "pending", "received", "shortage" ], "type": "string", "default": "pending" }, "condition": { "title": "Condition", "enum": [ "not_assessed", "first_quality", "damage_pending", "damaged" ], "type": "string", "default": "not_assessed" }, "disposition": { "title": "Disposition", "enum": [ "active", "lost_in_hub", "closed", "donated" ], "type": "string", "default": "active" }, "loaded": { "title": "Loaded", "type": "boolean", "default": false }, "loadBlockedReason": { "title": "Loadblockedreason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "HubScanRequest": { "title": "HubScanRequest", "required": [ "eventId", "barcode", "manifestVersion", "capturedAt", "deviceId" ], "type": "object", "properties": { "eventId": { "title": "Eventid", "type": "string", "format": "uuid" }, "barcode": { "title": "Barcode", "minLength": 1, "type": "string" }, "manifestVersion": { "title": "Manifestversion", "maxLength": 64, "minLength": 64, "pattern": "^[0-9a-f]{64}$", "type": "string" }, "capturedAt": { "title": "Capturedat", "type": "string", "format": "date-time" }, "deviceId": { "title": "Deviceid", "maxLength": 128, "minLength": 1, "type": "string" } } }, "HubScanResult": { "title": "HubScanResult", "required": [ "eventId", "routeId", "manifestVersion", "barcode", "outcome", "acceptedCount", "expectedCount", "serverReceivedAt" ], "type": "object", "properties": { "eventId": { "title": "Eventid", "type": "string", "format": "uuid" }, "routeId": { "title": "Routeid", "type": "string" }, "manifestVersion": { "title": "Manifestversion", "type": "string" }, "barcode": { "title": "Barcode", "type": "string" }, "outcome": { "$ref": "#/components/schemas/HubScanOutcome" }, "orderId": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "itemId": { "title": "Itemid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "acceptedCount": { "title": "Acceptedcount", "type": "integer" }, "expectedCount": { "title": "Expectedcount", "type": "integer" }, "serverReceivedAt": { "title": "Serverreceivedat", "type": "string", "format": "date-time" }, "expectedRouteId": { "title": "Expectedrouteid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "expectedRouteName": { "title": "Expectedroutename", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "loadBlockedReason": { "title": "Loadblockedreason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "IdentifierInputSerializer": { "title": "IdentifierInputSerializer", "required": [ "type", "value" ], "type": "object", "properties": { "type": { "title": "Type", "type": "string", "description": "The type of identifier", "example": "UPC" }, "value": { "title": "Value", "type": "string", "description": "The value of the identifier", "example": "123456789012" } } }, "IdentifierOutputSerializer": { "title": "IdentifierOutputSerializer", "required": [ "type", "value" ], "type": "object", "properties": { "type": { "title": "Type", "type": "string", "description": "The type of identifier", "example": "UPC" }, "value": { "title": "Value", "type": "string", "description": "The value of the identifier", "example": "123456789012" } } }, "ImageProof": { "title": "ImageProof", "required": [ "podType", "imageUrl" ], "type": "object", "properties": { "podType": { "title": "Podtype", "enum": [ "photo_proof_of_delivery", "signature_proof_of_delivery", "photo_proof_of_pickup", "signature_proof_of_pickup", "photo_pre_delivery_verification" ], "type": "string", "description": "Type of image artifact." }, "imageUrl": { "title": "Imageurl", "type": "string", "description": "URL of the captured image." } }, "description": "Image-based proof captured at pickup or dropoff (photo or signature)." }, "ImportDispatchPlanOrders": { "title": "ImportDispatchPlanOrders", "required": [ "expectedRevision", "orderIds" ], "type": "object", "properties": { "expectedRevision": { "title": "Expectedrevision", "minimum": 0.0, "type": "integer", "description": "The `revision` of the plan you last read." }, "orderIds": { "title": "Orderids", "maxItems": 22000, "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "Orders to add to the backlog." } }, "additionalProperties": false }, "ImportDispatchPlanRoutes": { "title": "ImportDispatchPlanRoutes", "required": [ "expectedRevision", "routeIds" ], "type": "object", "properties": { "expectedRevision": { "title": "Expectedrevision", "minimum": 0.0, "type": "integer", "description": "The `revision` of the plan you last read." }, "routeIds": { "title": "Routeids", "maxItems": 1500, "minItems": 1, "type": "array", "items": { "minLength": 1, "type": "string" }, "description": "Undispatched routes to take." } }, "additionalProperties": false }, "ImportedDispatchPlanOrders": { "title": "ImportedDispatchPlanOrders", "required": [ "planId", "revision", "contentHash", "importedOrderIds", "unchangedOrderIds", "memberCount" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "contentHash": { "title": "Contenthash", "type": "string" }, "importedOrderIds": { "title": "Importedorderids", "type": "array", "items": { "type": "string" }, "description": "Orders that joined the plan's backlog." }, "unchangedOrderIds": { "title": "Unchangedorderids", "type": "array", "items": { "type": "string" }, "description": "Orders the plan already held, left as they were." }, "memberCount": { "title": "Membercount", "type": "integer", "description": "Orders the plan holds now." } } }, "ImportedDispatchPlanRoute": { "title": "ImportedDispatchPlanRoute", "required": [ "sourceRouteId", "draftRouteId" ], "type": "object", "properties": { "sourceRouteId": { "title": "Sourcerouteid", "type": "string" }, "draftRouteId": { "title": "Draftrouteid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ImportedDispatchPlanRoutes": { "title": "ImportedDispatchPlanRoutes", "required": [ "planId", "revision", "contentHash", "routes", "importedRouteIds", "unchangedRouteIds", "importedOrderIds", "memberCount" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "contentHash": { "title": "Contenthash", "type": "string" }, "routes": { "title": "Routes", "type": "array", "items": { "$ref": "#/components/schemas/ImportedDispatchPlanRoute" } }, "importedRouteIds": { "title": "Importedrouteids", "type": "array", "items": { "type": "string" }, "description": "Routes taken into the plan and archived." }, "unchangedRouteIds": { "title": "Unchangedrouteids", "type": "array", "items": { "type": "string" }, "description": "Routes the plan already took, left as they were." }, "importedOrderIds": { "title": "Importedorderids", "type": "array", "items": { "type": "string" }, "description": "Orders that joined the plan with the taken routes." }, "memberCount": { "title": "Membercount", "type": "integer", "description": "Orders the plan holds now." } } }, "InternalDriverNotAssignedParams": { "title": "InternalDriverNotAssignedParams", "required": [ "minutes" ], "type": "object", "properties": { "minutes": { "title": "Minutes", "type": "number" }, "referenceStatus": { "title": "Referencestatus", "enum": [ "job_created", "pickup_start_time" ], "type": "string", "default": "job_created" } } }, "InventoryDiscountInputSerializer": { "title": "InventoryDiscountInputSerializer", "required": [ "valueCents", "startTime", "endTime" ], "type": "object", "properties": { "valueCents": { "title": "Valuecents", "type": "integer", "description": "The discounted price in cents", "example": 270 }, "startTime": { "title": "Starttime", "type": "string", "description": "The start time of the discount period in ISO 8601 format", "example": "2025-12-10T00:00:00Z" }, "endTime": { "title": "Endtime", "type": "string", "description": "The end time of the discount period in ISO 8601 format", "example": "2025-12-17T00:00:00Z" } } }, "InventoryDiscountOutputSerializer": { "title": "InventoryDiscountOutputSerializer", "required": [ "valueCents", "startTime", "endTime" ], "type": "object", "properties": { "valueCents": { "title": "Valuecents", "type": "integer", "description": "The discounted price in cents", "example": 270 }, "startTime": { "title": "Starttime", "type": "string", "description": "The start time of the discount period in ISO 8601 format", "example": "2025-12-10T00:00:00Z" }, "endTime": { "title": "Endtime", "type": "string", "description": "The end time of the discount period in ISO 8601 format", "example": "2025-12-17T00:00:00Z" } } }, "InventoryPaginationOutput": { "title": "InventoryPaginationOutput", "required": [ "inventory", "totalResults" ], "type": "object", "properties": { "inventory": { "title": "Inventory", "type": "array", "items": { "$ref": "#/components/schemas/StoreInventoryOutputSerializer" } }, "totalResults": { "title": "Totalresults", "type": "integer" } } }, "InventoryProviderConfigInputSerializer": { "title": "InventoryProviderConfigInputSerializer", "required": [ "provider", "serviceType", "valueCents", "currency" ], "type": "object", "properties": { "provider": { "title": "Provider", "type": "string", "description": "Provider name", "example": "X" }, "serviceType": { "title": "Servicetype", "type": "string", "description": "Service type (e.g., pick_and_deliver, marketplace)", "example": "pick_and_deliver" }, "valueCents": { "title": "Valuecents", "type": "integer", "description": "The price of the product in cents for this provider", "example": 299 }, "currency": { "title": "Currency", "type": "string", "description": "The currency code for the product price", "example": "USD" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/StoreInventoryDetailsInputSerializer" }, { "type": "null" } ], "description": "Additional pricing details for this provider", "default": null }, "available": { "title": "Available", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this provider config is available", "default": null, "example": true }, "discount": { "anyOf": [ { "$ref": "#/components/schemas/InventoryDiscountInputSerializer" }, { "type": "null" } ], "description": "Optional discount pricing for this provider config", "default": null, "example": { "endTime": "2025-12-17T00:00:00Z", "startTime": "2025-12-10T00:00:00Z", "valueCents": 270 } }, "taxPercentage": { "title": "Taxpercentage", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Tax rate as a decimal (e.g., 0.1 for 10%)", "default": null, "example": 0.1 } } }, "InventoryProviderConfigOutputSerializer": { "title": "InventoryProviderConfigOutputSerializer", "required": [ "provider", "serviceType", "valueCents", "currency" ], "type": "object", "properties": { "provider": { "title": "Provider", "type": "string", "description": "Provider name", "example": "X" }, "serviceType": { "title": "Servicetype", "type": "string", "description": "Service type (e.g., pick_and_deliver, marketplace)", "example": "pick_and_deliver" }, "valueCents": { "title": "Valuecents", "type": "integer", "description": "The price of the product in cents for this provider", "example": 299 }, "currency": { "title": "Currency", "type": "string", "description": "The currency code for the product price", "example": "USD" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/StoreInventoryDetailsOutputSerializer" }, { "type": "null" } ], "description": "Additional pricing details for this provider", "default": null }, "available": { "title": "Available", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this provider config is available", "default": null, "example": true }, "discount": { "anyOf": [ { "$ref": "#/components/schemas/InventoryDiscountOutputSerializer" }, { "type": "null" } ], "description": "Optional discount pricing for this provider config", "default": null, "example": { "endTime": "2025-12-17T00:00:00Z", "startTime": "2025-12-10T00:00:00Z", "valueCents": 270 } }, "taxPercentage": { "title": "Taxpercentage", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Tax rate as a decimal (e.g., 0.1 for 10%)", "default": null, "example": 0.1 } } }, "InventorySyncRequest": { "title": "InventorySyncRequest", "type": "object", "properties": { "all": { "title": "All", "type": "boolean", "description": "Sync every store configured for SFTP catalog sync in this org.", "default": false }, "store_external_ids": { "title": "Store External Ids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Explicit store external ids to sync. Mutually exclusive with `all`; exactly one is required.", "default": null } } }, "InventorySyncResponse": { "title": "InventorySyncResponse", "required": [ "run_activity_id", "planned_stores" ], "type": "object", "properties": { "run_activity_id": { "title": "Run Activity Id", "type": "string" }, "planned_stores": { "title": "Planned Stores", "type": "integer" }, "unknown_store_external_ids": { "title": "Unknown Store External Ids", "type": "array", "items": { "type": "string" }, "description": "Requested store external ids that aren't configured for SFTP catalog sync (skipped, not synced)." } } }, "IssueWidgetEmbedCredentialBody": { "title": "IssueWidgetEmbedCredentialBody", "required": [ "name" ], "type": "object", "properties": { "name": { "title": "Name", "maxLength": 120, "minLength": 1, "type": "string", "description": "Operator-facing label, e.g. 'production'." }, "expires_at": { "title": "Expires At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Optional expiry. Omit for a non-expiring credential.", "default": null } }, "additionalProperties": false }, "ItemInput": { "title": "ItemInput", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The merchant ID of the item", "default": null, "example": "abc-123" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the item", "default": null, "example": "A box of books" }, "count": { "title": "Count", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the item", "default": null, "example": 2 }, "dimensions": { "anyOf": [ { "$ref": "#/components/schemas/Dimensions" }, { "type": "null" } ], "description": "The dimensions of the item", "default": null, "example": { "depth": 14, "height": 10, "width": 12 } }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The weight of the item in kilograms (kg)", "default": null, "example": 1.5 }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The value of the item in cents", "default": null, "example": 1000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of requirements for this item", "default": null, "example": [ "age_verification_on_delivery" ] }, "category": { "title": "Category", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The category of the item", "default": null }, "barcode": { "title": "Barcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Barcode value for this item.", "default": null, "example": "0199312650999998913643M221872801002010908" }, "metadata": { "title": "Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this item.", "default": null, "example": { "packaging_type": "CTN" } }, "volume": { "title": "Volume", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The volume of the item in cubic centimeters (cm^3)", "default": null, "example": 1200 }, "subItems": { "title": "Subitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SubItemInput" } }, { "type": "null" } ], "description": "The nested sub-items", "default": null } }, "description": "Item input object for API requests." }, "ItemOutput": { "title": "ItemOutput", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The merchant ID of the item", "default": null, "example": "abc-123" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the item", "default": null, "example": "A box of books" }, "count": { "title": "Count", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the item", "default": null, "example": 2 }, "dimensions": { "anyOf": [ { "$ref": "#/components/schemas/Dimensions" }, { "type": "null" } ], "description": "The dimensions of the item", "default": null, "example": { "depth": 14, "height": 10, "width": 12 } }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The weight of the item in kilograms (kg)", "default": null, "example": 1.5 }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The value of the item in cents", "default": null, "example": 1000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of requirements for this item", "default": null, "example": [ "age_verification_on_delivery" ] }, "category": { "title": "Category", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The category of the item", "default": null }, "barcode": { "title": "Barcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Barcode value for this item.", "default": null, "example": "0199312650999998913643M221872801002010908" }, "metadata": { "title": "Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this item.", "default": null, "example": { "packaging_type": "CTN" } }, "subItems": { "title": "Subitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SubItemOutput" } }, { "type": "null" } ], "description": "The nested sub-items", "default": null } }, "description": "Item object returned by the API." }, "ItemScanSerializer": { "title": "ItemScanSerializer", "type": "object", "properties": { "substitutionType": { "title": "Substitutiontype", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "barcodes": { "title": "Barcodes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/BarcodeInfoSerializer" } }, { "type": "null" } ], "default": null } }, "description": "Serializer for individual item scans." }, "ItemStatusHistoryEntrySerializer": { "title": "ItemStatusHistoryEntrySerializer", "required": [ "status", "createdAt" ], "type": "object", "properties": { "status": { "title": "Status", "type": "string", "description": "Item status at this point in time", "example": "picked" }, "createdAt": { "title": "Createdat", "type": "string", "description": "Timestamp of the status change", "example": "2025-04-25T03:20:00" }, "occurredAt": { "title": "Occurredat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Time the action happened on the driver's device, when known", "default": null } }, "description": "A single status change entry in an item's status history." }, "ItemStatusMetadataSerializer": { "title": "ItemStatusMetadataSerializer", "type": "object", "properties": { "pickedAt": { "title": "Pickedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the item was picked up", "default": null }, "deliveredAt": { "title": "Deliveredat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the item was delivered", "default": null }, "failedAt": { "title": "Failedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the item delivery failed", "default": null }, "returnedAt": { "title": "Returnedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the item was returned", "default": null }, "failureReason": { "title": "Failurereason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reason for delivery failure", "default": null }, "failureLocation": { "title": "Failurelocation", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the failure occurred: 'pickup' or 'dropoff'", "default": null, "example": "dropoff" } }, "description": "Operational metadata tracked during item lifecycle in route delivery." }, "JobConfigurationsSerializer": { "title": "JobConfigurationsSerializer", "required": [ "id", "package", "tasks" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Job Configuration ID", "example": "cfg_01234567890" }, "orderId": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Canonical Nash order ID for this job configuration", "default": null }, "package": { "$ref": "#/components/schemas/PackageSerializer", "description": "Package" }, "tasks": { "title": "Tasks", "type": "array", "items": { "$ref": "#/components/schemas/TaskSerializer" }, "description": "Tasks" }, "advancedTask": { "title": "Advancedtask", "anyOf": [ { "$ref": "#/components/schemas/TaskSerializer" }, { "$ref": "#/components/schemas/CompressedAdvancedTaskSerializer" }, { "type": "null" } ], "description": "Advanced task", "default": null }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/DeliverySerializer" }, { "type": "null" } ], "description": "Delivery", "default": null }, "publicTrackingUrl": { "title": "Publictrackingurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public tracking URL", "default": null, "example": "https://usenash.com/tracking/job_abc123" } }, "description": "Generic serializer for jbo configurations used in many endpoints." }, "JobDeliverySummary": { "title": "JobDeliverySummary", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "providerName": { "title": "Providername", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "courierName": { "title": "Couriername", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "trackingUrl": { "title": "Trackingurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "priceCents": { "title": "Pricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "JobListItem": { "title": "JobListItem", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "shortReferenceCode": { "title": "Shortreferencecode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "isBatch": { "title": "Isbatch", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "createdAt": { "title": "Createdat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "routeId": { "title": "Routeid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "portalUrl": { "title": "Portalurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pickup": { "anyOf": [ { "$ref": "#/components/schemas/JobLocationSummary" }, { "type": "null" } ], "default": null }, "dropoff": { "anyOf": [ { "$ref": "#/components/schemas/JobLocationSummary" }, { "type": "null" } ], "default": null }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/JobDeliverySummary" }, { "type": "null" } ], "default": null } } }, "JobLocationSummary": { "title": "JobLocationSummary", "type": "object", "properties": { "businessName": { "title": "Businessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "city": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "state": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "country": { "title": "Country", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "JobsListResponse": { "title": "JobsListResponse", "required": [ "results", "totalCount", "limit", "offset" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/JobListItem" } }, "totalCount": { "title": "Totalcount", "type": "integer" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" } } }, "JsonValue": {}, "KeyedChange": { "title": "KeyedChange", "required": [ "id", "kind", "changes" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "kind": { "title": "Kind", "enum": [ "added", "removed", "changed" ], "type": "string" }, "changes": { "title": "Changes", "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } } } }, "LatLngSerializer": { "title": "LatLngSerializer", "required": [ "lat", "lng" ], "type": "object", "properties": { "lat": { "title": "Lat", "type": "number", "description": "Latitude coordinate.", "example": 45.558214 }, "lng": { "title": "Lng", "type": "number", "description": "Longitude coordinate.", "example": -122.587074 } }, "description": "Latitude/longitude coordinates." }, "ListContractsResponse": { "title": "ListContractsResponse", "required": [ "contracts" ], "type": "object", "properties": { "contracts": { "title": "Contracts", "type": "array", "items": { "$ref": "#/components/schemas/ContractReadDetailed" } }, "next_cursor": { "title": "Next Cursor", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "description": "Response body for ``GET /v1/contracts``.\n\nItems are typed as the wider ``ContractReadDetailed``. In summary mode the\nservice nulls the detailed fields so summary callers get a uniform shape\nwith the extra fields blanked." }, "ListDriverGroupsResponse": { "title": "ListDriverGroupsResponse", "required": [ "driverGroups" ], "type": "object", "properties": { "driverGroups": { "title": "Drivergroups", "type": "array", "items": { "$ref": "#/components/schemas/DriverGroupRead" } }, "nextCursor": { "title": "Nextcursor", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "ListNotificationTriggerTemplatesResponse": { "title": "ListNotificationTriggerTemplatesResponse", "type": "object", "properties": { "templates": { "title": "Templates", "type": "array", "items": { "$ref": "#/components/schemas/NotificationTriggerTemplateResponse" } } } }, "ListNotificationTriggersResponse": { "title": "ListNotificationTriggersResponse", "type": "object", "properties": { "notificationTriggers": { "title": "Notificationtriggers", "type": "array", "items": { "$ref": "#/components/schemas/NotificationTriggerResponse" } } } }, "ListOptionsGroupOutputSerializer": { "title": "ListOptionsGroupOutputSerializer", "type": "array", "items": { "$ref": "#/components/schemas/OptionsGroupSerializer" }, "description": "Expected output for listing options groups." }, "ListOrgProvidersOutputSerializer": { "title": "ListOrgProvidersOutputSerializer", "type": "array", "items": { "$ref": "#/components/schemas/OrgProviderPayload" }, "description": "Expected output when listing org providers, it will return an array of this." }, "ListOrganizationChildrenResponse": { "title": "ListOrganizationChildrenResponse", "type": "object", "properties": { "children": { "title": "Children", "type": "array", "items": { "$ref": "#/components/schemas/OrganizationSummaryResponse" }, "description": "Direct child organizations of the authenticated organization." } } }, "ListRefundRequestResponse": { "title": "ListRefundRequestResponse", "type": "array", "items": { "$ref": "#/components/schemas/RefundRequestResponse" }, "description": "Expected output for listing refund requests." }, "ListStoreLocationsResponse": { "title": "ListStoreLocationsResponse", "required": [ "storeLocations" ], "type": "object", "properties": { "storeLocations": { "title": "Storelocations", "type": "array", "items": { "$ref": "#/components/schemas/StoreLocationResponse" } } }, "description": "Response for list store locations." }, "ListZoneRestrictionsResponse": { "title": "ListZoneRestrictionsResponse", "required": [ "zoneRestrictions" ], "type": "object", "properties": { "zoneRestrictions": { "title": "Zonerestrictions", "type": "array", "items": { "$ref": "#/components/schemas/ZoneRestrictionResponse" } } }, "description": "Response for list zone restrictions." }, "ListZonesResponse": { "title": "ListZonesResponse", "required": [ "zones" ], "type": "object", "properties": { "zones": { "title": "Zones", "type": "array", "items": { "$ref": "#/components/schemas/ZoneResponse" } } }, "description": "Response for list zones." }, "LocationDataInputSerializer": { "title": "LocationDataInputSerializer", "type": "object", "properties": { "aisle": { "title": "Aisle", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The aisle location of the product in the store", "default": null, "example": "Aisle 5" }, "bay": { "title": "Bay", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The bay location of the product in the store", "default": null, "example": "Bay 3" }, "shelf": { "title": "Shelf", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The shelf location of the product in the store", "default": null, "example": "Shelf 2" } } }, "LocationDataOutputSerializer": { "title": "LocationDataOutputSerializer", "type": "object", "properties": { "aisle": { "title": "Aisle", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The aisle location of the product in the store", "default": null, "example": "Aisle 5" }, "bay": { "title": "Bay", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The bay location of the product in the store", "default": null, "example": "Bay 3" }, "shelf": { "title": "Shelf", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The shelf location of the product in the store", "default": null, "example": "Shelf 2" } } }, "LocationSerializer": { "title": "LocationSerializer", "required": [ "id", "address", "formattedAddress", "addressCity", "addressCountry", "timezoneId", "timezoneName" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Location ID", "example": "loc_01234567890" }, "address": { "title": "Address", "type": "string", "description": "Address", "example": "1600 Amphitheatre Parkway" }, "formattedAddress": { "title": "Formattedaddress", "type": "string", "description": "Formatted address", "example": "1600 Amphitheatre Parkway" }, "addressNumber": { "title": "Addressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Address number", "default": null, "example": "1600" }, "addressFormattedStreet": { "title": "Addressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Address formatted street", "default": null, "example": "Amphitheatre Parkway" }, "addressCity": { "title": "Addresscity", "type": "string", "description": "Address city", "example": "Mountain View" }, "addressCounty": { "title": "Addresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Address county", "default": null, "example": "Santa Clara" }, "addressState": { "title": "Addressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Address state", "default": null, "example": "CA" }, "addressZip": { "title": "Addresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Address zip", "default": null, "example": "94043" }, "addressCountry": { "title": "Addresscountry", "type": "string", "description": "Address country", "example": "US" }, "timezoneId": { "title": "Timezoneid", "type": "string", "description": "Timezone ID", "example": "America/Los_Angeles" }, "timezoneName": { "title": "Timezonename", "type": "string", "description": "Timezone name", "example": "Pacific Time" }, "instructions": { "title": "Instructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Instructions", "default": null, "example": "Turn left on Main St" }, "businessName": { "title": "Businessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Business name", "default": null, "example": "Nash" }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name", "default": null, "example": "John" }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name", "default": null, "example": "Doe" }, "phoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Phone number", "default": null, "example": "+15555555555" }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Email", "default": null, "example": "john.doe@example.com" }, "lat": { "title": "Lat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Latitude", "default": null, "example": 37.774929 }, "lng": { "title": "Lng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Longitude", "default": null, "example": -122.419416 } }, "description": "Generic serializer for location used in many endpoints." }, "ManifestDocumentSerializer": { "title": "ManifestDocumentSerializer", "required": [ "id", "url", "contentType" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Document ID." }, "url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL to download the manifest PDF." }, "contentType": { "title": "Contenttype", "type": "string", "description": "MIME type of the document." } } }, "ManifestOrderErrorSerializer": { "title": "ManifestOrderErrorSerializer", "required": [ "stage", "message" ], "type": "object", "properties": { "identifier": { "title": "Identifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Caller-supplied identifier (external_id, or positional like orders[2]).", "default": null }, "orderId": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nash order ID, present once the order has been created.", "default": null }, "stage": { "title": "Stage", "type": "string", "description": "Stage at which the failure occurred: 'create', 'dispatch', 'validate', 'manifest'." }, "message": { "title": "Message", "type": "string", "description": "Human-readable failure message." }, "details": { "title": "Details", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Opaque debug blob with provider-level context when available (e.g. provider_status_code, provider_message, provider_response_body). Keys inside this object are not subject to the camelCase contract \u2014 treat as free-form.", "default": null } } }, "ManifestOrderInput": { "title": "ManifestOrderInput", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order unique identifier from an external system.", "default": null }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null }, "pickupStoreLocationIds": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of store location IDs (internal or external) to consider for the Order. The optimal store will be selected and returned in the response in `pickupStoreLocationId` and/or `pickupStoreLocationExternalId`.", "default": null }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.", "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff. Limited to 280 characters.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values/types that are required to be scanned at the dropoff waypoint.", "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "'now' or 'scheduled' when the delivery should be scheduled", "default": null }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "deliveryWindowId": { "title": "Deliverywindowid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delivery window id if using Nash delivery windows", "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order description and notes. Limited to 280 characters.", "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of items in this order", "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local currency", "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Order value in cents", "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tip paid to the driver in cents", "default": null }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Set it to valueCents for a cash-on-delivery order and to 0 for a prepaid one; must not exceed valueCents. Omit when not applicable \u2014 providers then treat the order as prepaid. Forwarded to providers that support collect-on-delivery (currently Dash).", "default": null, "example": 10000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PackageRequirements" } }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order.\n\n Note: Best practice is to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this order.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Optional order tags, they will be included in every response", "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "The total weight of the package in kilograms (kg)", "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for weight: 'kg' or 'lbs'. Defaults to 'kg'. Weight is always stored in kg; a weight provided in 'lbs' is converted on ingest.", "default": null }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total height of the package in centimeters (cm)", "default": null }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total width of the package in centimeters (cm)", "default": null }, "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total depth of the package in centimeters (cm)", "default": null }, "volume": { "title": "Volume", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total volume of the package in cubic centimeters (cm^3)", "default": null }, "lengthUnit": { "title": "Lengthunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for height/width/depth and volume: 'cm' or 'in'. Defaults to 'cm'. Dimensions are always stored in cm (cm^3 for volume); values provided in 'in' (cubic inches for volume) are converted on ingest.", "default": null }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "Lists of items in the delivery", "default": null }, "optimizationParameters": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParameters" }, { "type": "null" } ], "description": "Order-level optimization parameters", "default": null }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null }, "reapplyAutomations": { "title": "Reapplyautomations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If set to true, the order will be re-evaluated with automations.", "default": null }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum delivery fee for the order in cents. This will override the dispatch strategy max delivery fee if both are set.", "default": null }, "shippingDetails": { "anyOf": [ { "$ref": "#/components/schemas/ShippingDetails" }, { "type": "null" } ], "description": "Shipping attributes for this order when manifesting.", "default": null } }, "description": "Order input for manifest creation \u2014 extends OrderInput with shipping details." }, "ManifestOrdersInputSerializer": { "title": "ManifestOrdersInputSerializer", "type": "object", "properties": { "orderIds": { "title": "Orderids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of Nash order IDs to manifest.", "default": null }, "externalOrderIds": { "title": "Externalorderids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of external order IDs to manifest.", "default": null }, "providerIds": { "title": "Providerids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of provider IDs. Manifests all eligible orders dispatched to these providers.", "default": null } }, "description": "Manifest orders that have already been dispatched." }, "ManifestOrdersResponseSerializer": { "title": "ManifestOrdersResponseSerializer", "required": [ "manifests" ], "type": "object", "properties": { "manifests": { "title": "Manifests", "type": "array", "items": { "$ref": "#/components/schemas/ManifestResultSerializer" }, "description": "List of manifest results grouped by provider and store location." } } }, "ManifestResultSerializer": { "title": "ManifestResultSerializer", "required": [ "providerId", "orderIds", "documents" ], "type": "object", "properties": { "providerId": { "title": "Providerid", "type": "string", "description": "Provider that generated the manifest." }, "storeLocationId": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup store location the manifested orders were grouped by.", "default": null }, "orderIds": { "title": "Orderids", "type": "array", "items": { "type": "string" }, "description": "Order IDs included in the manifest." }, "documents": { "title": "Documents", "type": "array", "items": { "$ref": "#/components/schemas/ManifestDocumentSerializer" }, "description": "Generated manifest documents." } } }, "MaskFaceInPhotoInputSerializer": { "title": "MaskFaceInPhotoInputSerializer", "required": [ "imageUrl" ], "type": "object", "properties": { "imageUrl": { "title": "Imageurl", "type": "string", "description": "Public URL of the image whose faces should be masked." } } }, "MessageType": { "title": "MessageType", "enum": [ "sms", "email" ], "type": "string", "description": "Enum for message delivery types." }, "MoveDispatchPlanOrders": { "title": "MoveDispatchPlanOrders", "required": [ "expectedRevision", "selection" ], "type": "object", "properties": { "expectedRevision": { "title": "Expectedrevision", "minimum": 0.0, "type": "integer", "description": "The `revision` of the plan you last read." }, "selection": { "$ref": "#/components/schemas/DispatchPlanSelection", "description": "The orders to move: named orders plus every order on the named draft routes." } }, "additionalProperties": false }, "MutationResult": { "title": "MutationResult", "type": "object", "properties": { "success": { "title": "Success", "type": "boolean", "default": true } }, "description": "Standard success response for role mutation endpoints." }, "NashErrorDetails": { "title": "NashErrorDetails", "required": [ "code", "message" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" }, "details": { "title": "Details", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Structured error context; shape depends on `code`. For `VALIDATION_ERRORS` (HTTP 422) it is `{\"fields\": [{\"loc\": [...], \"msg\": \"...\", \"type\": \"...\"}]}` \u2014 one entry per invalid field, where `loc` is the field path, `msg` the human-readable message, and `type` the machine-readable error type (e.g. `string_type`, `missing`).", "default": null } } }, "NashValidationError": { "title": "NashValidationError", "required": [ "error", "response_status", "RequestID" ], "type": "object", "properties": { "error": { "$ref": "#/components/schemas/NashErrorDetails" }, "response_status": { "title": "Response Status", "type": "string" }, "RequestID": { "title": "Requestid", "type": "string" } } }, "NearbyCourier": { "title": "NearbyCourier", "required": [ "courier_id", "courier_name", "route_id", "route_name", "route_status", "lat", "lng", "captured_at", "distance_meters" ], "type": "object", "properties": { "courier_id": { "title": "Courier Id", "type": "string" }, "courier_name": { "title": "Courier Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "route_id": { "title": "Route Id", "type": "string" }, "route_name": { "title": "Route Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "route_status": { "$ref": "#/components/schemas/RouteStatus" }, "lat": { "title": "Lat", "type": "number" }, "lng": { "title": "Lng", "type": "number" }, "captured_at": { "title": "Captured At", "type": "string", "format": "date-time" }, "distance_meters": { "title": "Distance Meters", "type": "integer", "description": "Straight-line distance from the query point." } } }, "NearbyCouriersResponse": { "title": "NearbyCouriersResponse", "required": [ "couriers" ], "type": "object", "properties": { "couriers": { "title": "Couriers", "type": "array", "items": { "$ref": "#/components/schemas/NearbyCourier" }, "description": "Nearest first." } } }, "NoteSerializer": { "title": "NoteSerializer", "required": [ "id", "createdAt", "note", "user" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Note ID", "example": "not_01234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "Created at", "example": "2023-08-29T19:17:46.264523" }, "note": { "title": "Note", "type": "string", "description": "Note", "example": "Task note" }, "user": { "anyOf": [ { "$ref": "#/components/schemas/BasicUserSerializer" }, { "type": "null" } ], "description": "User", "example": { "email": "john.doe@example.com" } } }, "description": "Generic serializer for notes used in many endpoints." }, "NotificationTriggerCatalogResponse": { "title": "NotificationTriggerCatalogResponse", "type": "object", "properties": { "filterCriteria": { "title": "Filtercriteria", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FilterCriterion" }, "description": "Shared filter criteria available to every trigger, keyed by FilterCriterionKey." }, "actions": { "title": "Actions", "type": "array", "items": { "$ref": "#/components/schemas/TriggerAction" }, "description": "Available action types that can be configured on a trigger." }, "triggers": { "title": "Triggers", "type": "array", "items": { "$ref": "#/components/schemas/TriggerCatalogEntry" }, "description": "One entry per NotificationTriggerType member." } }, "description": "Full catalog response for GET /v1/notification-triggers/catalog." }, "NotificationTriggerOutputSerializer": { "title": "NotificationTriggerOutputSerializer", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Notification trigger ID" }, "name": { "title": "Name", "type": "string", "description": "Notification trigger name" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Notification trigger description", "default": null } } }, "NotificationTriggerResponse": { "title": "NotificationTriggerResponse", "required": [ "id", "type", "name", "enabled" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Notification trigger ID" }, "type": { "title": "Type", "type": "string", "description": "Trigger type slug, matching a template from GET /v1/notification-triggers/templates, e.g. 'tasks_attempts_exhausted'." }, "name": { "title": "Name", "type": "string", "description": "Human-readable name of this trigger instance" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Trigger description", "default": null }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the trigger is enabled" }, "notificationGroupIds": { "title": "Notificationgroupids", "type": "array", "items": { "type": "string" }, "description": "Notification group IDs that receive notifications when this trigger fires." } }, "description": "A notification trigger configured on an organization." }, "NotificationTriggerSlug": { "title": "NotificationTriggerSlug", "enum": [ "delivery_incident_report", "status_changed_too_quickly", "dropoff_delayed", "driver_geolocation", "pickup_delayed", "driver_location_vs_delivery_status", "stuck_status", "task_reassignment", "delivery_status_transition", "autodispatch_failed", "address_validation_failed", "order_needs_attention", "order_ready_to_fulfill", "job_creation_failed", "delivery_cancellation_failed", "task_health_status", "internal_driver_not_assigned", "nash_ai_invalid_pod", "delivery_completed_too_early", "order_not_dispatched_close_to_pickup", "tasks_attempts_exhausted", "refund_request", "optimization_order_unassigned", "zone_geolocation", "api_based", "status_triggered_too_early", "optimization_action_status", "driver_stacking", "time_elapsed_since_status", "activity_status_transition", "demo", "custom_event_listener", "proof_of_delivery_uploaded", "courier_updated", "timing_updated", "ai_conversation_completed", "delivery_window_booked_timeout", "order_modified", "route_status_transition", "catchment_violation", "late_departure", "vehicle_breakdown", "customer_not_home", "adhoc_break", "vehicle_overweight", "vehicle_oversize", "refuel_request", "order_pickup_start_time", "order_pickup_end_time", "order_dropoff_start_time", "order_dropoff_end_time", "order_cutoff_time", "conversation_message_received", "conversation_assigned", "conversation_resolved", "conversation_reopened", "conversation_handler_changed" ], "type": "string" }, "NotificationTriggerTemplateResponse": { "title": "NotificationTriggerTemplateResponse", "required": [ "type", "title" ], "type": "object", "properties": { "type": { "title": "Type", "type": "string", "description": "Stable trigger type slug. Pass this value as `type` when creating a trigger, e.g. 'tasks_attempts_exhausted'." }, "title": { "title": "Title", "type": "string", "description": "Human-readable title of the trigger template, e.g. 'Tasks Attempts Exhausted'." } }, "description": "A pre-defined notification trigger template that can be instantiated for an org." }, "NotificationTriggerType": { "title": "NotificationTriggerType", "enum": [ "18zdfialfe|Delivery Incident Report", "8e2b5ead2b|Statuses changed too quickly", "z9aaa5b61b|Dropoff Delayed - Dropoff ETA too far after specified dropoff time", "a62ccd6cf7|Driver Geolocation", "8adu432fxx|Pickup Delayed - Pickup ETA too far after specified pickup time", "2d00e8337d|Driver location inconsistent with delivery status", "d9abb5b61b|\"Stuck\" Status", "xuf71kdfa7|Task Reassignment", "50851e6311|Delivery Status Transition", "0slfyzlxy3|Autodispatch Failed", "qd2910zx34|Address Validation Failed", "20231018|Nash order needs attention", "20231201|Nash order ready to fulfill", "ouut3gfaey|Job Creation Failed", "6101a86efd|Delivery Cancellation Failed", "72f25b6941|Live Monitoring Status", "a0240620|Internal Driver Not Assigned", "8x567890|Invalid Proof of Delivery Photo", "9f9uu7z0|Delivery Completed Too Early", "ix38123456|Order Not Dispatched Close to Pickup", "86dc85e3|Tasks Attempts Exhausted", "8dxl093456|Refund Request", "19f1kx1j2|Optimization Unassigned Order", "pqr123f5s|Zone Geolocation", "2ef442ca|API Based", "rt32km97j|Status Triggered Too Early", "03dekfned|Optimization Action Status", "az8dfllk8|Driver Stacking", "b37098781|Time Elapsed Since Status", "44t6kh981k|Activity Status Transition", "k3m8t9zqf|Demo", "c7e4f91a3b|Custom Event Listener", "f8d2a1b3c4|Proof of Delivery Uploaded", "e7c9b5d6a2|Courier Updated", "d4f6e8a1b9|Timing Updated", "c3b7d9e2f5|AI Conversation Completed", "a9f3e0c7d2|Delivery Window Booked Timeout", "m4d1f1c8e6|Order Modified", "a8f3d91c4e|Route Status Transition", "7c8a2f9d31|Catchment Violation", "1a4d2b7c8e|Late Departure", "9b2c8e1d4a|Vehicle Breakdown", "cnh4a2b8c1|Customer Not Home", "adb3f7e2c9|Ad-hoc Break", "vow8c1a2b9|Vehicle Overweight", "voz1b9c8a4|Vehicle Oversize", "rfl5d2c7e9|Refuel Request", "9c755f719f|Order Pickup Start Time", "1f13cca356|Order Pickup End Time", "fb157fe42d|Order Dropoff Start Time", "c182d4fc52|Order Dropoff End Time", "5da6b80bd3|Order Cutoff Time", "9oe472bzqz|Conversation Message Received", "2jrtca2xgr|Conversation Assigned", "wlf7eehna2|Conversation Resolved", "6girre519g|Conversation Reopened", "rl2vhjhq0t|Conversation Handler Changed" ], "type": "string" }, "OptimizationActionStatusParams": { "title": "OptimizationActionStatusParams", "required": [ "optimizationActionStatus" ], "type": "object", "properties": { "optimizationActionStatus": { "title": "Optimizationactionstatus", "enum": [ "failed", "success", "skipped" ], "type": "string" } } }, "OptimizationBalanceRoutes": { "title": "OptimizationBalanceRoutes", "enum": [ "none", "same_vehicle_type", "all_vehicle_types" ], "type": "string" }, "OptimizationCancellationError": { "title": "OptimizationCancellationError", "required": [ "code", "message" ], "type": "object", "properties": { "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" } } }, "OptimizationCancellationMode": { "title": "OptimizationCancellationMode", "enum": [ "STOPPED", "INTERRUPTING", "DISCARD_ON_RETURN" ], "type": "string", "description": "What cancelling did to the solve.\n\nSTOPPED: the activity had not started; it never will.\nINTERRUPTING: the solver is a submit-then-poll vendor; the worker abandons it at its next\n poll tick.\nDISCARD_ON_RETURN: the solver is a single blocking call that cannot be interrupted; the\n worker throws its result away when it returns." }, "OptimizationCancellationOutcome": { "title": "OptimizationCancellationOutcome", "required": [ "activity_id" ], "type": "object", "properties": { "activity_id": { "title": "Activity Id", "type": "string" }, "activity": { "anyOf": [ { "$ref": "#/components/schemas/CancelledActivityRead" }, { "type": "null" } ], "default": null }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationCancellationMode" }, { "type": "null" } ], "default": null }, "error": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationCancellationError" }, { "type": "null" } ], "default": null } }, "description": "One id's result. `error` is set when it could not be cancelled; `activity` and `mode`\notherwise. Partial success is the contract: a finished sibling never blocks the rest." }, "OptimizationParameters": { "title": "OptimizationParameters", "type": "object", "properties": { "pickupDoorstepTimeSeconds": { "title": "Pickupdoorsteptimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Length of time (in seconds) it take the courier at the pickup location's doorstep.", "default": null, "example": 90 }, "dropoffDoorstepTimeSeconds": { "title": "Dropoffdoorsteptimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Length of time (in seconds) it take the courier at the dropoff location's doorstep.", "default": null, "example": 180 }, "costsByMetric": { "title": "Costsbymetric", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The cost metric to use for the order", "default": null, "example": { "distance": 10, "weight": 200 } }, "clusterLabel": { "title": "Clusterlabel", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The cluster label for the order", "default": null }, "mxLabel": { "title": "Mxlabel", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The mutually exclusive label for the order", "default": null }, "assignmentPriority": { "title": "Assignmentpriority", "anyOf": [ { "maximum": 3, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "description": "The assignment priority for the order", "default": null }, "sequencePriority": { "title": "Sequencepriority", "anyOf": [ { "maximum": 499, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "description": "The sequence priority for the order", "default": null }, "sequenceGroup": { "title": "Sequencegroup", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The sequence group for the order", "default": null }, "pickupOnly": { "title": "Pickuponly", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether optimization creates a pickup-only order and omits the dropoff stop", "default": null }, "alternativeDropoffTimeWindows": { "title": "Alternativedropofftimewindows", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AlternativeDropoffTimeWindow" } }, { "type": "null" } ], "description": "Additional dropoff windows the optimizer may choose instead of the primary window", "default": null } } }, "OptimizationParams": { "title": "OptimizationParams", "type": "object", "properties": { "serviceTimeRelativeEfficiency": { "title": "Servicetimerelativeefficiency", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The service time relative efficiency of the shift.", "default": null, "example": 1.0 }, "plannedBreaks": { "title": "Plannedbreaks", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/BreakConfiguration" } }, { "type": "null" } ], "description": "The planned breaks of the shift. (in minutes)", "default": null, "example": [ { "end": 30, "start": 0 } ] }, "breakConfig": { "anyOf": [ { "$ref": "#/components/schemas/BreakConfig" }, { "type": "null" } ], "default": null }, "departureDelay": { "title": "Departuredelay", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The departure delay. (in minutes)", "default": null, "example": 15 }, "shiftEndServiceTimeMinutes": { "title": "Shiftendservicetimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Buffer between return to depot and shift end (e.g. refueling). (in minutes)", "default": null, "example": 10 }, "vehicleConfig": { "anyOf": [ { "$ref": "#/components/schemas/VehicleConfig" }, { "type": "null" } ], "description": "The vehicle config of the shift.", "default": null, "example": { "key": "value" } } }, "description": "Input for creating optimization params." }, "OptimizationScheduleInputSerializer": { "title": "OptimizationScheduleInputSerializer", "type": "object", "properties": { "cronExpression": { "title": "Cronexpression", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cron expression controlling when the strategy runs (input timezone).", "default": null }, "startDate": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Earliest time the schedule may fire.", "default": null }, "endDate": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Latest time the schedule may fire.", "default": null }, "inputTimezoneId": { "title": "Inputtimezoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IANA timezone id used to interpret the cron expression (e.g. 'America/New_York').", "default": null } } }, "OptimizationSolver": { "title": "OptimizationSolver", "enum": [ "logistics_os", "here", "gmpro", "ptv" ], "type": "string", "description": "Which solver engine runs the optimization.\n\nDistinct from Nash's ``OptimizationProvider`` (nash_enums): that enum is the\n*persisted* provider on ``route.optimization_provider`` and includes non-solver\nvalues (MANUAL, NAIVE) alongside the vendors. ``OptimizationSolver`` is the\nnarrower \"which engine\" selector for this module.\n\nAdding a solver here needs no schema change \u2014 ``route.optimization_provider`` is a\nplain varchar column \u2014 but it does need a new ``OptimizationProvider`` member and an\nentry in ``_SOLVER_TO_PROVIDER`` below. The mapping lives next to the enum precisely\nso that can't be missed: the engine originally shipped without it, and every\nengine-built route was recorded as LOGISTICS_OS (OPT-531)." }, "OptionsGroupInputMixin": { "title": "OptionsGroupInputMixin", "required": [ "label" ], "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "label": { "title": "Label", "maxLength": 80, "type": "string" }, "allowedProviders": { "title": "Allowedproviders", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "enableAutoDispatch": { "title": "Enableautodispatch", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "providerSelectionStrategy": { "title": "Providerselectionstrategy", "enum": [ "lowest_price", "preferred_order" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "reassignOnFailure": { "title": "Reassignonfailure", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "enableMaxDeliveryFee": { "title": "Enablemaxdeliveryfee", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "preventReassignmentPriceIncrease": { "title": "Preventreassignmentpriceincrease", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "costSplitStrategy": { "title": "Costsplitstrategy", "enum": [ "none", "price", "percentage" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "costSplitMaxPercentage": { "title": "Costsplitmaxpercentage", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "costSplitMaxFixedPriceCents": { "title": "Costsplitmaxfixedpricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "smartReassignment": { "title": "Smartreassignment", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null } }, "description": "Common schema for inputting a dispatch strategy." }, "OptionsGroupSerializer": { "title": "OptionsGroupSerializer", "required": [ "id", "label" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Dispatch Strategy ID", "example": "opn_WyMhHj" }, "label": { "title": "Label", "type": "string", "description": "Dispatch Strategy Label", "example": "New York City Strategy" }, "allowedProviders": { "title": "Allowedproviders", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Allowed providers", "default": null, "example": [ "prv_01234567890", "prv_01234567891" ] }, "enableAutoDispatch": { "title": "Enableautodispatch", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Enable auto dispatch", "default": null, "example": true }, "providerSelectionStrategy": { "title": "Providerselectionstrategy", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider selection strategy", "default": null, "example": "cheapest" }, "reassignOnFailure": { "title": "Reassignonfailure", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Reassign on failure", "default": null, "example": true }, "enableMaxDeliveryFee": { "title": "Enablemaxdeliveryfee", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Enable max delivery fee", "default": null, "example": true }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Max delivery fee in cents", "default": null, "example": 10000 }, "preventReassignmentPriceIncrease": { "title": "Preventreassignmentpriceincrease", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Prevent a reassignment from increasing the selected delivery fee", "default": null, "example": true }, "costSplitMaxFixedPriceCents": { "title": "Costsplitmaxfixedpricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cost split max fixed price in cents", "default": null, "example": 10000 }, "costSplitMaxPercentage": { "title": "Costsplitmaxpercentage", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Cost split max percentage", "default": null, "example": 0.1 }, "costSplitStrategy": { "title": "Costsplitstrategy", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cost split strategy", "default": null, "example": "price" }, "smartReassignment": { "title": "Smartreassignment", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Smart reassignment", "default": null, "example": true } }, "description": "Generic serializer for options groups used in many endpoints." }, "OrderChange": { "title": "OrderChange", "required": [ "order_id", "categories", "changes" ], "type": "object", "properties": { "order_id": { "title": "Order Id", "type": "string" }, "categories": { "title": "Categories", "type": "array", "items": { "$ref": "#/components/schemas/OrderFieldCategory" } }, "changes": { "title": "Changes", "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } } } }, "OrderDocumentOutput": { "title": "OrderDocumentOutput", "required": [ "createdAt", "id", "type", "contentType" ], "type": "object", "properties": { "createdAt": { "title": "Createdat", "type": "string", "description": "The date and time when the document was created", "format": "date-time", "example": "2023-08-29T19:17:46.264523" }, "id": { "title": "Id", "type": "string", "description": "The id of the document", "example": "doc_1234567890" }, "type": { "$ref": "#/components/schemas/DocumentType", "description": "The type of the document", "example": "shipping_label" }, "contentType": { "title": "Contenttype", "type": "string", "description": "The content type of the document", "example": "application/pdf" }, "url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The URL of the document", "default": null, "example": "https://example.com/document.pdf" }, "data": { "title": "Data", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The data of the document", "default": null, "example": "SGVsbG8gd29ybG=" } }, "description": "Document object returned by the API." }, "OrderDocumentResponse": { "title": "OrderDocumentResponse", "type": "array", "items": { "$ref": "#/components/schemas/OrderDocumentOutput" } }, "OrderFieldCategory": { "title": "OrderFieldCategory", "enum": [ "window", "address", "quantity", "capabilities", "service_duration", "priority", "legs", "other" ], "type": "string" }, "OrderIdPath": { "title": "OrderIdPath", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Unique reference number for the order: either order.id (starts with \"ord_\") or order.externalId", "example": "ord_1234567890" } } }, "OrderInput": { "title": "OrderInput", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order unique identifier from an external system.", "default": null }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null }, "pickupStoreLocationIds": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of store location IDs (internal or external) to consider for the Order. The optimal store will be selected and returned in the response in `pickupStoreLocationId` and/or `pickupStoreLocationExternalId`.", "default": null }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.", "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff. Limited to 280 characters.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values/types that are required to be scanned at the dropoff waypoint.", "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "'now' or 'scheduled' when the delivery should be scheduled", "default": null }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "deliveryWindowId": { "title": "Deliverywindowid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delivery window id if using Nash delivery windows", "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order description and notes. Limited to 280 characters.", "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of items in this order", "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local currency", "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Order value in cents", "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tip paid to the driver in cents", "default": null }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Set it to valueCents for a cash-on-delivery order and to 0 for a prepaid one; must not exceed valueCents. Omit when not applicable \u2014 providers then treat the order as prepaid. Forwarded to providers that support collect-on-delivery (currently Dash).", "default": null, "example": 10000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PackageRequirements" } }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order.\n\n Note: Best practice is to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this order.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Optional order tags, they will be included in every response", "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "The total weight of the package in kilograms (kg)", "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for weight: 'kg' or 'lbs'. Defaults to 'kg'. Weight is always stored in kg; a weight provided in 'lbs' is converted on ingest.", "default": null }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total height of the package in centimeters (cm)", "default": null }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total width of the package in centimeters (cm)", "default": null }, "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total depth of the package in centimeters (cm)", "default": null }, "volume": { "title": "Volume", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total volume of the package in cubic centimeters (cm^3)", "default": null }, "lengthUnit": { "title": "Lengthunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for height/width/depth and volume: 'cm' or 'in'. Defaults to 'cm'. Dimensions are always stored in cm (cm^3 for volume); values provided in 'in' (cubic inches for volume) are converted on ingest.", "default": null }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "Lists of items in the delivery", "default": null }, "optimizationParameters": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParameters" }, { "type": "null" } ], "description": "Order-level optimization parameters", "default": null }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null }, "reapplyAutomations": { "title": "Reapplyautomations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If set to true, the order will be re-evaluated with automations.", "default": null }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum delivery fee for the order in cents. This will override the dispatch strategy max delivery fee if both are set.", "default": null } }, "description": "Order input for creating an order." }, "OrderInputWithReturnFirstQuoteApiOnly": { "title": "OrderInputWithReturnFirstQuoteApiOnly", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order unique identifier from an external system.", "default": null }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null }, "pickupStoreLocationIds": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of store location IDs (internal or external) to consider for the Order. The optimal store will be selected and returned in the response in `pickupStoreLocationId` and/or `pickupStoreLocationExternalId`.", "default": null }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.", "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff. Limited to 280 characters.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values/types that are required to be scanned at the dropoff waypoint.", "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "'now' or 'scheduled' when the delivery should be scheduled", "default": null }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "deliveryWindowId": { "title": "Deliverywindowid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delivery window id if using Nash delivery windows", "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order description and notes. Limited to 280 characters.", "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of items in this order", "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local currency", "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Order value in cents", "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tip paid to the driver in cents", "default": null }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Set it to valueCents for a cash-on-delivery order and to 0 for a prepaid one; must not exceed valueCents. Omit when not applicable \u2014 providers then treat the order as prepaid. Forwarded to providers that support collect-on-delivery (currently Dash).", "default": null, "example": 10000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PackageRequirements" } }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order.\n\n Note: Best practice is to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this order.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Optional order tags, they will be included in every response", "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "The total weight of the package in kilograms (kg)", "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for weight: 'kg' or 'lbs'. Defaults to 'kg'. Weight is always stored in kg; a weight provided in 'lbs' is converted on ingest.", "default": null }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total height of the package in centimeters (cm)", "default": null }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total width of the package in centimeters (cm)", "default": null }, "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total depth of the package in centimeters (cm)", "default": null }, "volume": { "title": "Volume", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total volume of the package in cubic centimeters (cm^3)", "default": null }, "lengthUnit": { "title": "Lengthunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for height/width/depth and volume: 'cm' or 'in'. Defaults to 'cm'. Dimensions are always stored in cm (cm^3 for volume); values provided in 'in' (cubic inches for volume) are converted on ingest.", "default": null }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "Lists of items in the delivery", "default": null }, "optimizationParameters": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParameters" }, { "type": "null" } ], "description": "Order-level optimization parameters", "default": null }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null }, "reapplyAutomations": { "title": "Reapplyautomations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If set to true, the order will be re-evaluated with automations.", "default": null }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum delivery fee for the order in cents. This will override the dispatch strategy max delivery fee if both are set.", "default": null }, "returnFirstQuoteApiOnly": { "title": "Returnfirstquoteapionly", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If set to true, order quotes will only include the first available API quote", "default": null } } }, "OrderItemSerializer": { "title": "OrderItemSerializer", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The merchant ID of the item", "default": null, "example": "item-001" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the item", "default": null }, "count": { "title": "Count", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the item", "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The value of the item in cents", "default": null }, "barcode": { "title": "Barcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Barcode associated with the item", "default": null }, "sku": { "title": "Sku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "SKU of the item", "default": null }, "category": { "title": "Category", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The category of the item", "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Current lifecycle status of the item.", "default": null, "example": "delivered" }, "availableQuantity": { "title": "Availablequantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Quantity available after pickup (may differ from count)", "default": null }, "statusMetadata": { "anyOf": [ { "$ref": "#/components/schemas/ItemStatusMetadataSerializer" }, { "type": "null" } ], "description": "Operational metadata tracked during the item's lifecycle.", "default": null }, "statusHistory": { "title": "Statushistory", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemStatusHistoryEntrySerializer" } }, { "type": "null" } ], "description": "History of status changes for this item.", "default": null }, "subItems": { "title": "Subitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemSerializer" } }, { "type": "null" } ], "description": "Nested sub-items with their own status tracking.", "default": null } }, "description": "Item with status tracking for route stop webhook payloads.\n\nCombines item definition with lifecycle status from the route state machine." }, "OrderListItem": { "title": "OrderListItem", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "createdAt": { "title": "Createdat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "updatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pickup": { "anyOf": [ { "$ref": "#/components/schemas/OrderLocationSummary" }, { "type": "null" } ], "default": null }, "dropoff": { "anyOf": [ { "$ref": "#/components/schemas/OrderLocationSummary" }, { "type": "null" } ], "default": null }, "routeId": { "title": "Routeid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "portalUrl": { "title": "Portalurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "OrderLocationSummary": { "title": "OrderLocationSummary", "type": "object", "properties": { "businessName": { "title": "Businessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "city": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "state": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "country": { "title": "Country", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "startTime": { "title": "Starttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "endTime": { "title": "Endtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null } } }, "OrderModifiedField": { "title": "OrderModifiedField", "enum": [ "pickup_time", "dropoff_time", "pickup_location", "dropoff_location", "pickup_contact", "dropoff_contact", "pickup_instructions", "dropoff_instructions", "items", "tip", "order_value" ], "type": "string", "description": "Order fields selectable for the order_modified workflow trigger." }, "OrderModifiedParams": { "title": "OrderModifiedParams", "required": [ "modifiedFields" ], "type": "object", "properties": { "modifiedFields": { "title": "Modifiedfields", "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/OrderModifiedField" }, "description": "Order fields whose modification fires the trigger. The trigger fires when any of the selected fields changes on an order. Select one, several, or all fields." } } }, "OrderNeedsAttentionParams": { "title": "OrderNeedsAttentionParams", "type": "object", "properties": { "onlyOrdersWithDeliveryWindows": { "title": "Onlyorderswithdeliverywindows", "type": "boolean", "default": false } } }, "OrderNotDispatchedParams": { "title": "OrderNotDispatchedParams", "required": [ "metricValue" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" } } }, "OrderOutputExample": { "title": "OrderOutputExample", "required": [ "id", "createdAt", "portalUrl", "publicTrackingUrl", "status", "tags" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The id of the order", "example": "ord_1234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "The date and time when the order was created", "format": "date-time", "example": "2023-08-29T19:17:46.264523" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the order", "default": null, "example": "1234567890" }, "externalGroupId": { "title": "Externalgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external group id of the order", "default": null, "example": "1234567890" }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null, "example": "1234567890" }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "The URL of the order in the Nash portal", "example": "https://portal.dev.usenash.com/orders/ord_1234567890" }, "publicTrackingUrl": { "title": "Publictrackingurl", "type": "string", "description": "The URL of the order in the public tracking system", "example": "https://tracking.dev.usenash.com/ord_1234567890" }, "status": { "title": "Status", "type": "string", "description": "The status of the order", "example": "needs_attention" }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The tags of the order", "example": [ "REST_API" ] }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to Nash Jobs.", "default": null, "example": { "key": "value" } }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The pickup address of the order", "default": null, "example": "185 University Ave, Palo Alto, CA 94301" }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "185" }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "University Ave" }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null, "example": "Palo Alto" }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null, "example": "Santa Clara" }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null, "example": "CA" }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null, "example": "94301" }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null, "example": "US" }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null, "example": 37.422222 }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null, "example": -122.139776 }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null, "example": "+15555555555" }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null, "example": "store@example.com" }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin.", "default": null, "example": "Store ABC" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup.", "default": null, "example": "Leave at the front door" }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null, "example": "stl_VwpoPJaaqWiPGnXEhWfX" }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null, "example": "0021112" }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null, "example": [ "1234567890", "0987654321" ] }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null, "example": { "barcode": { "type": "CODE128", "value": "1234567890" }, "providerCard": false } }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dropoff address of the order", "default": null, "example": "401 San Antonio Rd, Mountain View, CA 94040" }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "401" }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "San Antonio Rd" }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null, "example": "Mountain View" }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null, "example": "Santa Clara" }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null, "example": "CA" }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null, "example": "94040" }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null, "example": "US" }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null, "example": 37.422222 }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null, "example": -122.139776 }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null, "example": "+15555555556" }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null, "example": "customer@example.com" }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination.", "default": null, "example": "Quote" }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination.", "default": null, "example": "Request" }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff business name at the destination.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff.", "default": null, "example": "Leave at the front door" }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the dropoff waypoint.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The delivery mode of the order", "default": null, "example": "scheduled" }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the order", "default": null, "example": "Order description" }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number of items in the order", "default": null, "example": "1" }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The requirements of the order", "default": null, "example": [ "photo_proof_of_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency of the order", "default": null, "example": "USD" }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The value of the order in cents", "default": null, "example": "10000" }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The tip amount of the order in cents", "default": null, "example": "1000" }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Null when not specified.", "default": null, "example": "10000" }, "width": { "title": "Width", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The width of the order in cm", "default": null, "example": "100" }, "depth": { "title": "Depth", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The depth of the order in cm", "default": null, "example": "100" }, "height": { "title": "Height", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The height of the order in cm", "default": null, "example": "100" }, "volume": { "title": "Volume", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The volume of the order in cm^3", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The weight of the order in kg", "default": null, "example": "100" }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "The items of the order", "default": null }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order. Note: It is the best practice to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null, "example": "dss_1234567890" }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The max delivery fee of the order in cents", "default": null, "example": "1000" }, "documents": { "title": "Documents", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrderDocumentOutput" } }, { "type": "null" } ], "description": "The documents of the order", "default": null, "example": [ { "contentType": "application/pdf", "data": "SGVsbG8gd29ybGQ=", "id": "doc_1234567890", "type": "shipping_label", "url": "https://example.com/document.pdf" } ] }, "validationErrors": { "title": "Validationerrors", "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The validation errors of the order", "default": null, "example": { "pickupStartTime": "Time is in the past" } }, "quotes": { "title": "Quotes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" } }, { "type": "null" } ], "description": "The quotes of the order", "default": null, "example": [ { "costSplitBusinessCents": null, "costSplitCustomerCents": null, "createdTime": "2024-09-03T20:43:45.899094", "currency": "USD", "dropoffEta": "2024-09-03T22:20:47.569000", "expireTime": "2024-09-03T21:43:45.899102", "id": "qot_2oWASjGxMtucwGgu6A7BYC", "insuranceFeeCents": 0, "nashFeeCents": 300, "pickupWindow": null, "priceCents": 100, "providerId": "dispatch_partner", "providerIsInternal": false, "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg", "providerName": "Dispatch", "tags": null, "taxAmountCents": null, "tollFeeCents": 0, "totalPriceBreakdown": { "priceCents": 100 }, "totalPriceCents": 100, "type": "LOCAL" } ] }, "failedQuotes": { "title": "Failedquotes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The failed quotes of the order", "default": null, "example": [ "quote_1234567890", "quote_0987654321" ] }, "quoteFailure": { "title": "Quotefailure", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Summary when every provider rejects the package requirements", "default": null } } }, "OrderResponse": { "title": "OrderResponse", "required": [ "id", "createdAt", "portalUrl", "publicTrackingUrl", "status", "tags" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The id of the order", "example": "ord_1234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "The date and time when the order was created", "format": "date-time", "example": "2023-08-29T19:17:46.264523" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the order", "default": null, "example": "1234567890" }, "externalGroupId": { "title": "Externalgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external group id of the order", "default": null, "example": "1234567890" }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null, "example": "1234567890" }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "The URL of the order in the Nash portal", "example": "https://portal.dev.usenash.com/orders/ord_1234567890" }, "publicTrackingUrl": { "title": "Publictrackingurl", "type": "string", "description": "The URL of the order in the public tracking system", "example": "https://tracking.dev.usenash.com/ord_1234567890" }, "status": { "title": "Status", "type": "string", "description": "The status of the order", "example": "needs_attention" }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The tags of the order", "example": [ "REST_API" ] }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to Nash Jobs.", "default": null, "example": { "key": "value" } }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The pickup address of the order", "default": null, "example": "185 University Ave, Palo Alto, CA 94301" }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "185" }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "University Ave" }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null, "example": "Palo Alto" }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null, "example": "Santa Clara" }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null, "example": "CA" }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null, "example": "94301" }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null, "example": "US" }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null, "example": 37.422222 }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null, "example": -122.139776 }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null, "example": "+15555555555" }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null, "example": "store@example.com" }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin.", "default": null, "example": "Store ABC" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup.", "default": null, "example": "Leave at the front door" }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null, "example": "stl_VwpoPJaaqWiPGnXEhWfX" }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null, "example": "0021112" }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null, "example": [ "1234567890", "0987654321" ] }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null, "example": { "barcode": { "type": "CODE128", "value": "1234567890" }, "providerCard": false } }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dropoff address of the order", "default": null, "example": "401 San Antonio Rd, Mountain View, CA 94040" }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "401" }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "San Antonio Rd" }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null, "example": "Mountain View" }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null, "example": "Santa Clara" }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null, "example": "CA" }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null, "example": "94040" }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null, "example": "US" }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null, "example": 37.422222 }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null, "example": -122.139776 }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null, "example": "+15555555556" }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null, "example": "customer@example.com" }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination.", "default": null, "example": "Quote" }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination.", "default": null, "example": "Request" }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff business name at the destination.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff.", "default": null, "example": "Leave at the front door" }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the dropoff waypoint.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The delivery mode of the order", "default": null, "example": "scheduled" }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the order", "default": null, "example": "Order description" }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number of items in the order", "default": null, "example": "1" }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The requirements of the order", "default": null, "example": [ "photo_proof_of_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency of the order", "default": null, "example": "USD" }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The value of the order in cents", "default": null, "example": "10000" }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The tip amount of the order in cents", "default": null, "example": "1000" }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Null when not specified.", "default": null, "example": "10000" }, "width": { "title": "Width", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The width of the order in cm", "default": null, "example": "100" }, "depth": { "title": "Depth", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The depth of the order in cm", "default": null, "example": "100" }, "height": { "title": "Height", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The height of the order in cm", "default": null, "example": "100" }, "volume": { "title": "Volume", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The volume of the order in cm^3", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The weight of the order in kg", "default": null, "example": "100" }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "The items of the order", "default": null }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order. Note: It is the best practice to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null, "example": "dss_1234567890" }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The max delivery fee of the order in cents", "default": null, "example": "1000" }, "documents": { "title": "Documents", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrderDocumentOutput" } }, { "type": "null" } ], "description": "The documents of the order", "default": null, "example": [ { "contentType": "application/pdf", "data": "SGVsbG8gd29ybGQ=", "id": "doc_1234567890", "type": "shipping_label", "url": "https://example.com/document.pdf" } ] }, "validationErrors": { "title": "Validationerrors", "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The validation errors of the order", "default": null, "example": { "pickupStartTime": "Time is in the past" } }, "quotes": { "title": "Quotes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" } }, { "type": "null" } ], "description": "The quotes of the order", "default": null, "example": [ { "costSplitBusinessCents": null, "costSplitCustomerCents": null, "createdTime": "2024-09-03T20:43:45.899094", "currency": "USD", "dropoffEta": "2024-09-03T22:20:47.569000", "expireTime": "2024-09-03T21:43:45.899102", "id": "qot_2oWASjGxMtucwGgu6A7BYC", "insuranceFeeCents": 0, "nashFeeCents": 300, "pickupWindow": null, "priceCents": 100, "providerId": "dispatch_partner", "providerIsInternal": false, "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg", "providerName": "Dispatch", "tags": null, "taxAmountCents": null, "tollFeeCents": 0, "totalPriceBreakdown": { "priceCents": 100 }, "totalPriceCents": 100, "type": "LOCAL" } ] }, "failedQuotes": { "title": "Failedquotes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The failed quotes of the order", "default": null, "example": [ "quote_1234567890", "quote_0987654321" ] }, "quoteFailure": { "title": "Quotefailure", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Summary when every provider rejects the package requirements", "default": null } }, "description": "`OrderOutputExample` serialisable directly from an `Order` ORM instance via\n`model_validate(order)` \u2014 the standard order response for layered order endpoints\nthat return the full order (e.g. the v1 undispatch endpoint).\n\nMirrors `BulkUpsertOrderData`'s ORM-serialisation config (`from_attributes` +\n`coerce_numbers_to_str`) and the `failed_quotes` id-projection the legacy GraphQL\nresolver performed. (`BulkUpsertOrderData` carries an identical setup; the two can be\nconsolidated in a follow-up.)" }, "OrderTimeParams": { "title": "OrderTimeParams", "type": "object", "properties": { "direction": { "title": "Direction", "enum": [ "before", "at", "after" ], "type": "string", "default": "at" }, "offsetMinutes": { "title": "Offsetminutes", "minimum": 0.0, "type": "integer", "default": 0 } }, "description": "Offset from an Order window milestone.\n\n``direction=\"at\"`` fires exactly on the milestone; ``before``/``after``\nshift it by ``offset_minutes``. Amount-plus-direction rather than a signed\ninteger so the builder can render a number box and a dropdown without the\nsign ambiguity." }, "OrderWithDeliveryWindowInput": { "title": "OrderWithDeliveryWindowInput", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order unique identifier from an external system.", "default": null }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null }, "pickupStoreLocationIds": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of store location IDs (internal or external) to consider for the Order. The optimal store will be selected and returned in the response in `pickupStoreLocationId` and/or `pickupStoreLocationExternalId`.", "default": null }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.", "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff. Limited to 280 characters.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values/types that are required to be scanned at the dropoff waypoint.", "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "'now' or 'scheduled' when the delivery should be scheduled", "default": null }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "deliveryWindowId": { "title": "Deliverywindowid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Specify the delivery window that the customer requested this order to be delivered.", "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order description and notes. Limited to 280 characters.", "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of items in this order", "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local currency", "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Order value in cents", "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tip paid to the driver in cents", "default": null }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Set it to valueCents for a cash-on-delivery order and to 0 for a prepaid one; must not exceed valueCents. Omit when not applicable \u2014 providers then treat the order as prepaid. Forwarded to providers that support collect-on-delivery (currently Dash).", "default": null, "example": 10000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PackageRequirements" } }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order.\n\n Note: Best practice is to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this order.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Optional order tags, they will be included in every response", "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "The total weight of the package in kilograms (kg)", "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for weight: 'kg' or 'lbs'. Defaults to 'kg'. Weight is always stored in kg; a weight provided in 'lbs' is converted on ingest.", "default": null }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total height of the package in centimeters (cm)", "default": null }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total width of the package in centimeters (cm)", "default": null }, "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total depth of the package in centimeters (cm)", "default": null }, "volume": { "title": "Volume", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total volume of the package in cubic centimeters (cm^3)", "default": null }, "lengthUnit": { "title": "Lengthunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for height/width/depth and volume: 'cm' or 'in'. Defaults to 'cm'. Dimensions are always stored in cm (cm^3 for volume); values provided in 'in' (cubic inches for volume) are converted on ingest.", "default": null }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "Lists of items in the delivery", "default": null }, "optimizationParameters": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParameters" }, { "type": "null" } ], "description": "Order-level optimization parameters", "default": null }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null }, "reapplyAutomations": { "title": "Reapplyautomations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If set to true, the order will be re-evaluated with automations.", "default": null }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum delivery fee for the order in cents. This will override the dispatch strategy max delivery fee if both are set.", "default": null }, "requestedDeliveryWindowsStartTime": { "title": "Requesteddeliverywindowsstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest delivery windows start time for the range of windows to return, in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "requestedDeliveryWindowsEndTime": { "title": "Requesteddeliverywindowsendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest delivery windows start time for the range of windows to return, in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "deliveryWindowExpiresAt": { "title": "Deliverywindowexpiresat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The time at which the booked delivery window expires", "default": null }, "deliveryWindowRequestedCapacity": { "title": "Deliverywindowrequestedcapacity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The amount of capacity to book from the delivery window for this order", "default": null } } }, "OrderWithDeliveryWindowOutputExample": { "title": "OrderWithDeliveryWindowOutputExample", "required": [ "id", "createdAt", "portalUrl", "publicTrackingUrl", "status", "tags" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The id of the order", "example": "ord_1234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "The date and time when the order was created", "format": "date-time", "example": "2023-08-29T19:17:46.264523" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the order", "default": null, "example": "1234567890" }, "externalGroupId": { "title": "Externalgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external group id of the order", "default": null, "example": "1234567890" }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null, "example": "1234567890" }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "The URL of the order in the Nash portal", "example": "https://portal.dev.usenash.com/orders/ord_1234567890" }, "publicTrackingUrl": { "title": "Publictrackingurl", "type": "string", "description": "The URL of the order in the public tracking system", "example": "https://tracking.dev.usenash.com/ord_1234567890" }, "status": { "title": "Status", "type": "string", "description": "The status of the order", "example": "needs_attention" }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The tags of the order", "example": [ "REST_API" ] }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to Nash Jobs.", "default": null, "example": { "key": "value" } }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The pickup address of the order", "default": null, "example": "185 University Ave, Palo Alto, CA 94301" }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "185" }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "University Ave" }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null, "example": "Palo Alto" }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null, "example": "Santa Clara" }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null, "example": "CA" }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null, "example": "94301" }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null, "example": "US" }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null, "example": 37.422222 }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null, "example": -122.139776 }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null, "example": "+15555555555" }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null, "example": "store@example.com" }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Manager" }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin.", "default": null, "example": "Store ABC" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup.", "default": null, "example": "Leave at the front door" }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null, "example": "stl_VwpoPJaaqWiPGnXEhWfX" }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null, "example": "0021112" }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null, "example": [ "1234567890", "0987654321" ] }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null, "example": { "barcode": { "type": "CODE128", "value": "1234567890" }, "providerCard": false } }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dropoff address of the order", "default": null, "example": "401 San Antonio Rd, Mountain View, CA 94040" }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null, "example": "ChIJd8BlQJq3t4kRUKhH43CQ" }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null, "example": "401" }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null, "example": "San Antonio Rd" }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null, "example": "Mountain View" }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null, "example": "Santa Clara" }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null, "example": "CA" }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null, "example": "94040" }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null, "example": "US" }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null, "example": 37.422222 }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null, "example": -122.139776 }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null, "example": "+15555555556" }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null, "example": "customer@example.com" }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination.", "default": null, "example": "Quote" }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination.", "default": null, "example": "Request" }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff business name at the destination.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff.", "default": null, "example": "Leave at the front door" }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the dropoff waypoint.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The delivery mode of the order", "default": null, "example": "scheduled" }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the pickup window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The start time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The end time of the dropoff window.", "default": null, "example": "2024-08-22T23:54:08Z" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the order", "default": null, "example": "Order description" }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number of items in the order", "default": null, "example": "1" }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The requirements of the order", "default": null, "example": [ "photo_proof_of_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency of the order", "default": null, "example": "USD" }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The value of the order in cents", "default": null, "example": "10000" }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The tip amount of the order in cents", "default": null, "example": "1000" }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Null when not specified.", "default": null, "example": "10000" }, "width": { "title": "Width", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The width of the order in cm", "default": null, "example": "100" }, "depth": { "title": "Depth", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The depth of the order in cm", "default": null, "example": "100" }, "height": { "title": "Height", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The height of the order in cm", "default": null, "example": "100" }, "volume": { "title": "Volume", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The volume of the order in cm^3", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The weight of the order in kg", "default": null, "example": "100" }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "The items of the order", "default": null }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order. Note: It is the best practice to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null, "example": "dss_1234567890" }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The max delivery fee of the order in cents", "default": null, "example": "1000" }, "documents": { "title": "Documents", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrderDocumentOutput" } }, { "type": "null" } ], "description": "The documents of the order", "default": null, "example": [ { "contentType": "application/pdf", "data": "SGVsbG8gd29ybGQ=", "id": "doc_1234567890", "type": "shipping_label", "url": "https://example.com/document.pdf" } ] }, "validationErrors": { "title": "Validationerrors", "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "The validation errors of the order", "default": null, "example": { "pickupStartTime": "Time is in the past" } }, "quotes": { "title": "Quotes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" } }, { "type": "null" } ], "description": "The quotes of the order", "default": null, "example": [ { "costSplitBusinessCents": null, "costSplitCustomerCents": null, "createdTime": "2024-09-03T20:43:45.899094", "currency": "USD", "dropoffEta": "2024-09-03T22:20:47.569000", "expireTime": "2024-09-03T21:43:45.899102", "id": "qot_2oWASjGxMtucwGgu6A7BYC", "insuranceFeeCents": 0, "nashFeeCents": 300, "pickupWindow": null, "priceCents": 100, "providerId": "dispatch_partner", "providerIsInternal": false, "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg", "providerName": "Dispatch", "tags": null, "taxAmountCents": null, "tollFeeCents": 0, "totalPriceBreakdown": { "priceCents": 100 }, "totalPriceCents": 100, "type": "LOCAL" } ] }, "failedQuotes": { "title": "Failedquotes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The failed quotes of the order", "default": null, "example": [ "quote_1234567890", "quote_0987654321" ] }, "quoteFailure": { "title": "Quotefailure", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Summary when every provider rejects the package requirements", "default": null }, "deliveryWindowId": { "title": "Deliverywindowid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The delivery window id that the end customer requested this order to be delivered in.", "default": null }, "deliveryWindowStatus": { "title": "Deliverywindowstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The status of the delivery window (e.g. booked, confirmed).", "default": null }, "deliveryWindowExpiresAt": { "title": "Deliverywindowexpiresat", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The delivery window expiration time of the booking.", "default": null }, "deliveryWindowRequestedCapacity": { "title": "Deliverywindowrequestedcapacity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested capacity of the Order to be deducted from the delivery window.", "default": null }, "eligibleDeliveryWindows": { "title": "Eligibledeliverywindows", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/EligibleDeliveryWindow" } }, { "type": "null" } ], "description": "The eligible delivery windows that the customers can choose from for this order.", "default": null }, "ineligibleDeliveryWindows": { "title": "Ineligibledeliverywindows", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/EligibleDeliveryWindow" } }, { "type": "null" } ], "description": "The ineligible delivery windows for the order.", "default": null }, "deliveryWindow": { "anyOf": [ { "$ref": "#/components/schemas/DeliveryWindowOutput" }, { "type": "null" } ], "description": "The delivery window object", "default": null } } }, "OrdersBulkOperationInput": { "title": "OrdersBulkOperationInput", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateOrderBulkPayload" }, { "$ref": "#/components/schemas/UpdateOrderBulkPayload" }, { "$ref": "#/components/schemas/UpsertOrderBulkPayload" }, { "$ref": "#/components/schemas/DeleteOrderBulkPayload" } ], "discriminator": { "propertyName": "action", "mapping": { "create": "#/components/schemas/CreateOrderBulkPayload", "delete": "#/components/schemas/DeleteOrderBulkPayload", "update": "#/components/schemas/UpdateOrderBulkPayload", "upsert": "#/components/schemas/UpsertOrderBulkPayload" } } } }, "OrdersDiff": { "title": "OrdersDiff", "required": [ "previous_order_count", "current_order_count", "added_order_ids", "removed_order_ids", "changed" ], "type": "object", "properties": { "previous_order_count": { "title": "Previous Order Count", "type": "integer" }, "current_order_count": { "title": "Current Order Count", "type": "integer" }, "added_order_ids": { "title": "Added Order Ids", "type": "array", "items": { "type": "string" } }, "removed_order_ids": { "title": "Removed Order Ids", "type": "array", "items": { "type": "string" } }, "changed": { "title": "Changed", "type": "array", "items": { "$ref": "#/components/schemas/OrderChange" } } } }, "OrdersListResponse": { "title": "OrdersListResponse", "required": [ "results", "totalCount", "limit", "offset" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/OrderListItem" } }, "totalCount": { "title": "Totalcount", "type": "integer" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" } } }, "OrdersOutputExample": { "title": "OrdersOutputExample", "type": "array", "items": { "$ref": "#/components/schemas/OrderOutputExample" } }, "OrgProviderPayload": { "title": "OrgProviderPayload", "required": [ "providerId", "name" ], "type": "object", "properties": { "providerId": { "title": "Providerid", "type": "string" }, "name": { "title": "Name", "type": "string" }, "logo": { "title": "Logo", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "OrganizationSummaryResponse": { "title": "OrganizationSummaryResponse", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Organization ID" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Organization name", "default": null } } }, "PackSizeSpecificationInputSerializer": { "title": "PackSizeSpecificationInputSerializer", "type": "object", "properties": { "value": { "title": "Value", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The size value", "default": null, "example": 100.0 }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the size specification", "default": null, "example": "Large" } } }, "PackSizeSpecificationOutputSerializer": { "title": "PackSizeSpecificationOutputSerializer", "type": "object", "properties": { "value": { "title": "Value", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The size value", "default": null, "example": 100.0 }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the size specification", "default": null, "example": "Large" } } }, "PackageRequirements": { "title": "PackageRequirements", "enum": [ "photo_proof_of_delivery", "signature_proof_of_delivery", "photo_proof_of_pickup", "photo_reference_on_dropoff", "photo_reference_capture_on_dropoff", "signature_proof_of_pickup", "photo_pre_delivery_verification", "age_verification_on_delivery", "id_verification_on_delivery", "barcode_scan_on_pickup", "barcode_scan_on_dropoff", "barcode_scan_on_return", "meet_on_delivery", "shipping_label", "two_person_team", "pincode_verification", "schedule_ii_controlled_substances", "alcohol", "tobacco", "vapes", "parking_check_in", "display_barcode_on_pickup", "pick_and_pack" ], "type": "string", "description": "Detailed description: https://docs.usenash.com/reference/package-requirements." }, "PackageSchemaMixin": { "title": "PackageSchemaMixin", "required": [ "packageDeliveryMode" ], "type": "object", "properties": { "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code], [country]. All address fields are required except \"second line\". Second line should include Apt/Suite/Unit/# appended to the number of the unit.", "default": null }, "pickupAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "pickupLatitude": { "title": "Pickuplatitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "pickupLongitude": { "title": "Pickuplongitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass \"Manager\". Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass \"Manager\". Limited to 80 characters.", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Google place ID for the pickup location.If passed, resolving the pickup location's lat/lng will happen with this field.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Nash store location ID for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the location in the form: \"+15555555555\"", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state], [zip code], [country]. All address fields are required except \"second line\". Second line should include Apt/Suite/Unit/# appended to the number of the unit.", "default": null }, "dropoffAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "dropoffLatitude": { "title": "Dropofflatitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "dropoffLongitude": { "title": "Dropofflongitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffExternalStoreLocationId": { "title": "Dropoffexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "packageDeliveryMode": { "title": "Packagedeliverymode", "type": "string" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters. Nash Recommended Input: Pickup order [insert order number] for [insert customer name] from [pickup business name].", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packagePickupStartTime": { "title": "Packagepickupstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packagePickupEndTime": { "title": "Packagepickupendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDropoffStartTime": { "title": "Packagedropoffstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDropoffEndTime": { "title": "Packagedropoffendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "default": null }, "packageDescription": { "title": "Packagedescription", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageValue": { "title": "Packagevalue", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "packageValueCents": { "title": "Packagevaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "packageTax": { "title": "Packagetax", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "packageServiceFee": { "title": "Packageservicefee", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "tipAmount": { "title": "Tipamount", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "tipAmountUsd": { "title": "Tipamountusd", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "packageExternalIdentifier": { "title": "Packageexternalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "packageMinimumVehicleSize": { "title": "Packageminimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "packageRequirements": { "title": "Packagerequirements", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PackageRequirements" }, { "pattern": "^(custom|preferred):.*", "type": "string" } ] } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "weight": { "title": "Weight", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "default": null }, "dimensions": { "title": "Dimensions", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "packageItems": { "title": "Packageitems", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "description": "Generic mixin for packages used in many endpoints; Used for input." }, "PackageSerializer": { "title": "PackageSerializer", "required": [ "id", "requirements", "valueCents", "itemsCount", "pickupLocation", "dropoffLocation" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Package ID", "example": "pkg_01234567890" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description", "default": null, "example": "Package description" }, "requirements": { "title": "Requirements", "type": "array", "items": { "type": "string" }, "description": "Requirements", "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Tags", "default": null, "example": [ "Alcohol" ] }, "packageDeliveryMode": { "title": "Packagedeliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Package delivery mode", "default": null, "example": "now" }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup start time", "default": null, "example": "2021-01-01T00:00:00Z" }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup end time", "default": null, "example": "2021-01-01T00:00:00Z" }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff start time", "default": null, "example": "2021-01-01T00:00:00Z" }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff end time", "default": null, "example": "2021-01-01T00:00:00Z" }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "valueCents": { "title": "Valuecents", "type": "integer" }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Null when the order did not specify one (treated as prepaid).", "default": null, "example": 10000 }, "taxCents": { "title": "Taxcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tax in cents", "default": null, "example": 100 }, "serviceFeeCents": { "title": "Servicefeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Service fee in cents", "default": null, "example": 100 }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "number" } ], "description": "Items count", "example": 100 }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier", "default": null, "example": "mini-mart-order-99" }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "pickupLocation": { "$ref": "#/components/schemas/LocationSerializer" }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup store location ID", "default": null, "example": "store_01234567890" }, "pickupStoreLocationExternalId": { "title": "Pickupstorelocationexternalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup store location external ID", "default": null, "example": "0123" }, "dropoffLocation": { "$ref": "#/components/schemas/LocationSerializer" }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff store location ID", "default": null, "example": "store_01234567890" }, "drivingMetrics": { "title": "Drivingmetrics", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Driving metrics (distance in meters, duration in seconds)", "default": null, "example": { "distance": 100, "duration": 100 } }, "value": { "title": "Value", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Value", "default": null, "example": 100.0 }, "tax": { "title": "Tax", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "description": "Tax", "default": null, "example": 100 }, "serviceFee": { "title": "Servicefee", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "description": "Service fee", "default": null, "example": 100 }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "description": "Weight", "default": null, "example": 100 }, "dimensions": { "title": "Dimensions", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Dimensions", "default": null, "example": { "height": 100, "length": 100, "width": 100 } }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemOutput" } }, { "type": "null" } ], "description": "Items", "default": null, "example": [ { "count": 1, "description": "Item 1", "valueCents": 100 } ] }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reference ID", "default": null, "example": "mini-mart-order-99" }, "packageMetadata": { "title": "Packagemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Package metadata", "default": null, "example": { "key": "value" } } }, "description": "Generic serializer for packages used in many endpoints; Used for output." }, "PageMeta": { "title": "PageMeta", "required": [ "total", "size", "offset" ], "type": "object", "properties": { "total": { "title": "Total", "type": "integer", "description": "Total rows matching the filter across all pages, ignoring size and offset.", "example": 137 }, "size": { "title": "Size", "type": "integer", "description": "Page size used for this response.", "example": 100 }, "offset": { "title": "Offset", "type": "integer", "description": "Offset used for this response.", "example": 0 } }, "description": "Offset-pagination metadata for a single page of a query response." }, "ParsedAddressInputSerializer": { "title": "ParsedAddressInputSerializer", "required": [ "street", "city", "country" ], "type": "object", "properties": { "number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number of the address.", "default": null, "example": "1600" }, "secondaryNumber": { "title": "Secondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The secondary number of the address.", "default": null, "example": null }, "street": { "title": "Street", "type": "string", "description": "The street of the address. If your geocoding service does not split numbers from street names, you can pass the street name with the number in this field. Example: 1600 Pennsylvania Avenue NW.", "example": "Pennsylvania Avenue NW" }, "county": { "title": "County", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county of the address.", "default": null, "example": "Washington" }, "city": { "title": "City", "type": "string", "description": "The city of the address.", "example": "Washington" }, "state": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the address.", "default": null, "example": "DC" }, "postalCode": { "title": "Postalcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The postal code of the address.", "default": null, "example": "20500" }, "country": { "title": "Country", "type": "string", "description": "The country of the address.", "example": "US" }, "latitude": { "title": "Latitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The latitude of the address.", "default": null, "example": 38.8948949 }, "longitude": { "title": "Longitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The longitude of the address.", "default": null, "example": -77.0371581 } }, "description": "Parsed address input serializer for creating a job." }, "PhotoType": { "title": "PhotoType", "enum": [ "pod", "pickup", "signature" ], "type": "string" }, "PickedItem": { "title": "PickedItem", "required": [ "sku", "status", "quantity" ], "type": "object", "properties": { "sku": { "title": "Sku", "maxLength": 255, "minLength": 1, "type": "string", "description": "SKU of the item picked. For a substitution, the substitute's SKU." }, "requestedSku": { "title": "Requestedsku", "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "SKU the order line asked for.", "default": null }, "id": { "title": "Id", "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Id of the order line item picked. Leave out for a substitute, which is not an order line.", "default": null }, "requestedId": { "title": "Requestedid", "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Id of the order line item this row answers.", "default": null }, "name": { "title": "Name", "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Display name of the item picked.", "default": null }, "status": { "title": "Status", "enum": [ "picked", "partially_picked", "not_picked", "substituted" ], "type": "string", "description": "Outcome for the line." }, "quantity": { "title": "Quantity", "maximum": 2147483647, "minimum": 0.0, "type": "integer", "description": "Units picked. 0 when the item was not picked." }, "requestedQuantity": { "title": "Requestedquantity", "anyOf": [ { "maximum": 2147483647, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "description": "Units the order line asked for.", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "description": "Weight picked, for an item sold by weight.", "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "Unit of `weight`. E.g. 'kg'.", "default": null }, "priceCents": { "title": "Pricecents", "anyOf": [ { "maximum": 2147483647, "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "description": "Price of the item picked, in cents.", "default": null }, "scannedBarcode": { "title": "Scannedbarcode", "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Barcode scanned at the pick. Leave out for an item with no barcode.", "default": null }, "substitutionType": { "anyOf": [ { "$ref": "#/components/schemas/PickedItemSubstitutionType" }, { "type": "null" } ], "description": "How a substitute was chosen, or `no_substitution` for the item ordered.", "default": null }, "substitutionSource": { "title": "Substitutionsource", "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "description": "Who listed the order line's substitutes. E.g. 'customer' or 'merchant'.", "default": null } }, "description": "A line answered by both the item ordered and a substitute is two rows that share ``requested_sku``." }, "PickedItemSubstitutionType": { "title": "PickedItemSubstitutionType", "enum": [ "no_substitution", "pre_selected", "override", "contact_customer" ], "type": "string" }, "PickedItemsSerializer": { "title": "PickedItemsSerializer", "type": "object", "properties": { "sku": { "title": "Sku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "requestedSku": { "title": "Requestedsku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "requestedId": { "title": "Requestedid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "quantity": { "title": "Quantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "requestedQuantity": { "title": "Requestedquantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "scannedBarcode": { "title": "Scannedbarcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "priceCents": { "title": "Pricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Per-item fulfillment outcome at pick time. One of: `picked`, `partially_picked`, `not_picked`, `substituted`.", "default": null }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "scans": { "title": "Scans", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemScanSerializer" } }, { "type": "null" } ], "default": null } }, "description": "Generic serializer for picked items; Used for output." }, "PickupDelayedParams": { "title": "PickupDelayedParams", "required": [ "metricValue" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" }, "metricName": { "title": "Metricname", "type": "string", "default": "minutes", "const": "minutes" } } }, "PickupPayment": { "title": "PickupPayment", "type": "object", "properties": { "barcode": { "anyOf": [ { "$ref": "#/components/schemas/PickupPaymentBarcode" }, { "type": "null" } ], "description": "Barcode the courier presents at the pickup location to pay for the order.", "default": null }, "providerCard": { "title": "Providercard", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If true, the courier pays for the order at pickup using a provider-issued card.", "default": null, "example": true } } }, "PickupPaymentBarcode": { "title": "PickupPaymentBarcode", "type": "object", "properties": { "type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The barcode symbology (e.g. CODE128, QR).", "default": null, "example": "CODE128" }, "value": { "title": "Value", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The barcode value the courier should present at pickup.", "default": null, "example": "1234567890" } } }, "PlanDigest": { "title": "PlanDigest", "required": [ "planId", "revision", "contentHash", "isClean", "name", "source", "startDate", "endDate", "timezoneId", "zoneIds", "totals", "issues", "issueCount", "routes", "unplannedOrderIds", "unplannedCount" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "contentHash": { "title": "Contenthash", "type": "string" }, "isClean": { "title": "Isclean", "type": "boolean" }, "name": { "title": "Name", "type": "string" }, "source": { "title": "Source", "enum": [ "orders", "routes", "snapshot" ], "type": "string" }, "startDate": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ] }, "endDate": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ] }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "zoneIds": { "title": "Zoneids", "type": "array", "items": { "type": "string" } }, "totals": { "$ref": "#/components/schemas/PlanDigestTotals" }, "issues": { "title": "Issues", "type": "array", "items": { "$ref": "#/components/schemas/PlanDigestIssue" } }, "issueCount": { "title": "Issuecount", "type": "integer" }, "routes": { "title": "Routes", "type": "array", "items": { "$ref": "#/components/schemas/PlanDigestRoute" } }, "unplannedOrderIds": { "title": "Unplannedorderids", "type": "array", "items": { "type": "string" } }, "unplannedCount": { "title": "Unplannedcount", "type": "integer" } } }, "PlanDigestIssue": { "title": "PlanDigestIssue", "required": [ "code", "message" ], "type": "object", "properties": { "code": { "title": "Code", "enum": [ "ROUTE_NOT_CALCULATED", "ORDER_INPUTS_NOT_CAPTURED" ], "type": "string" }, "routeId": { "title": "Routeid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "orderId": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "message": { "title": "Message", "type": "string" } } }, "PlanDigestRoute": { "title": "PlanDigestRoute", "required": [ "routeId", "label", "vehicleId", "stops", "orders", "start", "end", "warnings" ], "type": "object", "properties": { "routeId": { "title": "Routeid", "type": "string" }, "label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "vehicleId": { "title": "Vehicleid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stops": { "title": "Stops", "type": "integer" }, "orders": { "title": "Orders", "type": "integer" }, "start": { "title": "Start", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "end": { "title": "End", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "warnings": { "title": "Warnings", "type": "array", "items": { "enum": [ "ROUTE_NOT_CALCULATED", "ORDER_INPUTS_NOT_CAPTURED" ], "type": "string" } } } }, "PlanDigestTotals": { "title": "PlanDigestTotals", "required": [ "routes", "stops", "orders", "unplanned", "distanceMeters", "durationSeconds" ], "type": "object", "properties": { "routes": { "title": "Routes", "type": "integer" }, "stops": { "title": "Stops", "type": "integer" }, "orders": { "title": "Orders", "type": "integer" }, "unplanned": { "title": "Unplanned", "type": "integer" }, "distanceMeters": { "title": "Distancemeters", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "durationSeconds": { "title": "Durationseconds", "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "PlanLocation": { "title": "PlanLocation", "required": [ "latitude", "longitude" ], "type": "object", "properties": { "latitude": { "title": "Latitude", "maximum": 90, "minimum": -90.0, "type": "number" }, "longitude": { "title": "Longitude", "maximum": 180, "minimum": -180.0, "type": "number" } }, "additionalProperties": false }, "PlanRouteDetail": { "title": "PlanRouteDetail", "required": [ "revision", "routeId", "stops" ], "type": "object", "properties": { "revision": { "title": "Revision", "type": "integer" }, "routeId": { "title": "Routeid", "type": "string" }, "stops": { "title": "Stops", "type": "array", "items": { "$ref": "#/components/schemas/PlanRouteStop" } } } }, "PlanRouteStop": { "title": "PlanRouteStop", "required": [ "stopId", "type", "orderIds", "eta", "location", "window", "windowConflict" ], "type": "object", "properties": { "stopId": { "title": "Stopid", "type": "string" }, "type": { "title": "Type", "enum": [ "PICKUP", "DROPOFF", "ROUTE_START", "ROUTE_END", "DRIVER_BREAK" ], "type": "string" }, "orderIds": { "title": "Orderids", "type": "array", "items": { "type": "string" } }, "eta": { "title": "Eta", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "location": { "anyOf": [ { "$ref": "#/components/schemas/PlanLocation" }, { "type": "null" } ] }, "window": { "anyOf": [ { "$ref": "#/components/schemas/PlanStopWindow" }, { "type": "null" } ] }, "windowConflict": { "title": "Windowconflict", "type": "boolean" } } }, "PlanStopWindow": { "title": "PlanStopWindow", "required": [ "start", "end" ], "type": "object", "properties": { "start": { "title": "Start", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "end": { "title": "End", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } }, "PlannedBreakWindow": { "title": "PlannedBreakWindow", "required": [ "start_offset", "end_offset", "duration" ], "type": "object", "properties": { "start_offset": { "title": "Start Offset", "type": "string", "format": "duration" }, "end_offset": { "title": "End Offset", "type": "string", "format": "duration" }, "duration": { "title": "Duration", "type": "string", "format": "duration" } }, "description": "Offsets from `Shift.actual_start` / `Shift.planned_start`; absolute times are caller-computed." }, "PreviousState": { "title": "PreviousState", "enum": [ "routed", "unassigned", "absent" ], "type": "string", "description": "What the previous run did with an order that the current run dropped." }, "ProductInputSerializer": { "title": "ProductInputSerializer", "required": [ "name", "categories", "weight", "dimensions", "identifiers" ], "type": "object", "properties": { "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external ID of the product from an external system", "default": null, "example": "ext_001" }, "sku": { "title": "Sku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Stock Keeping Unit (SKU) for the product", "default": null, "example": "ORG-BAN-001" }, "name": { "title": "Name", "type": "string", "description": "The name of the product", "example": "Organic Bananas" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the product", "default": null, "example": "Fresh organic bananas, perfect for smoothies and baking" }, "imageUrls": { "title": "Imageurls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of image URLs for the product", "default": null, "example": [ "https://example.com/bananas1.jpg", "https://example.com/bananas2.jpg" ] }, "categories": { "title": "Categories", "type": "array", "items": { "type": "string" }, "description": "List of categories the product belongs to", "example": [ "Produce", "Fruits", "Organic" ] }, "weight": { "title": "Weight", "type": "number", "description": "The weight of the product", "example": 0.5 }, "dimensions": { "$ref": "#/components/schemas/DimensionInputSerializer", "description": "Dimensions of the product", "example": { "depth": 8.0, "height": 4.0, "width": 12.0 } }, "identifiers": { "title": "Identifiers", "type": "array", "items": { "$ref": "#/components/schemas/IdentifierInputSerializer" }, "description": "List of identifiers for the product", "example": [ { "type": "UPC", "value": "123456789012" } ] }, "attributes": { "title": "Attributes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of attributes for the product", "default": null, "example": [ "WEIGHTED" ] }, "details": { "anyOf": [ { "$ref": "#/components/schemas/DetailsInputSerializer" }, { "type": "null" } ], "description": "Additional product details including weight and size specifications", "default": null, "example": { "packSizeSpecification": { "description": "10 units per pack", "value": 10 }, "sizeSpecification": { "description": "ea", "value": 1.0 }, "weightedItemInfo": { "weightPerItem": 0.12, "weightUnit": "kg" } } }, "providerConfigs": { "title": "Providerconfigs", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigInputSerializer" } }, { "type": "null" } ], "description": "Provider-specific configurations for this product", "default": null, "example": [ { "categories": [ "Produce", "Fruits", "Organic" ], "provider": "X", "serviceType": "pick_and_deliver" } ] } } }, "ProductOutputSerializer": { "title": "ProductOutputSerializer", "required": [ "id", "name" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external ID of the product from an external system", "default": null, "example": "ext_001" }, "sku": { "title": "Sku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The Stock Keeping Unit (SKU) for the product", "default": null, "example": "11111" }, "name": { "title": "Name", "type": "string", "description": "The name of the product", "example": "Organic Bananas" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the product", "default": null, "example": "Fresh organic bananas, perfect for smoothies and baking" }, "imageUrls": { "title": "Imageurls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of image URLs for the product", "default": null, "example": [ "https://example.com/bananas1.jpg", "https://example.com/bananas2.jpg" ] }, "categories": { "title": "Categories", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of categories the product belongs to", "default": null, "example": [ "Produce", "Fruits", "Organic" ] }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight of the product", "default": null, "example": 0.5 }, "dimensions": { "anyOf": [ { "$ref": "#/components/schemas/DimensionOutputSerializer" }, { "type": "null" } ], "description": "Dimensions of the product", "default": null, "example": { "depth": 8.0, "height": 4.0, "width": 12.0 } }, "identifiers": { "title": "Identifiers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/IdentifierOutputSerializer" } }, { "type": "null" } ], "description": "List of identifiers for the product", "default": null, "example": [ { "type": "UPC", "value": "123456789012" } ] }, "attributes": { "title": "Attributes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of attributes for the product", "default": null, "example": [ "WEIGHTED" ] }, "details": { "anyOf": [ { "$ref": "#/components/schemas/DetailsOutputSerializer" }, { "type": "null" } ], "description": "Additional product details including weight and size specifications", "default": null, "example": { "packSizeSpecification": { "description": "10 units per pack", "value": 10 }, "sizeSpecification": { "description": "ea", "value": 1.0 }, "weightedItemInfo": { "weightPerItem": 0.12, "weightUnit": "kg" } } }, "providerConfigs": { "title": "Providerconfigs", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigOutputSerializer" } }, { "type": "null" } ], "description": "Provider-specific configurations for this product", "default": null, "example": [ { "categories": [ "Produce", "Fruits", "Organic" ], "provider": "X", "serviceType": "pick_and_deliver" } ] } } }, "ProductsInputSerializer": { "title": "ProductsInputSerializer", "required": [ "products" ], "type": "object", "properties": { "products": { "title": "Products", "type": "array", "items": { "$ref": "#/components/schemas/ProductInputSerializer" }, "description": "List of products to create" } } }, "ProductsOutputSerializer": { "title": "ProductsOutputSerializer", "type": "array", "items": { "$ref": "#/components/schemas/ProductOutputSerializer" }, "description": "Expected output when listing products, it will return an array of ProductOutputSerializer." }, "ProductsPaginationOutput": { "title": "ProductsPaginationOutput", "required": [ "products", "totalResults" ], "type": "object", "properties": { "products": { "title": "Products", "type": "array", "items": { "$ref": "#/components/schemas/ProductOutputSerializer" } }, "totalResults": { "title": "Totalresults", "type": "integer" } } }, "ProjectedContractFleet": { "title": "ProjectedContractFleet", "required": [ "requested_contract_ids", "contract_id", "first_version_contract_id", "uses_physical_vehicles", "vehicles" ], "type": "object", "properties": { "requested_contract_ids": { "title": "Requested Contract Ids", "type": "array", "items": { "type": "string" } }, "contract_id": { "title": "Contract Id", "type": "string" }, "first_version_contract_id": { "title": "First Version Contract Id", "type": "string" }, "uses_physical_vehicles": { "title": "Uses Physical Vehicles", "type": "boolean" }, "vehicles": { "title": "Vehicles", "type": "array", "items": { "$ref": "#/components/schemas/ProjectedVehicle" } } } }, "ProjectedVehicle": { "title": "ProjectedVehicle", "required": [ "id", "contract_id", "source", "vehicle_count", "use_all_vehicles", "multi_dispatch", "max_num_dispatches", "capabilities", "start_depot_store_location_ids", "end_depot_store_location_ids" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "contract_id": { "title": "Contract Id", "type": "string" }, "source": { "title": "Source", "enum": [ "contract", "vehicle" ], "type": "string" }, "vehicle_count": { "title": "Vehicle Count", "type": "integer" }, "use_all_vehicles": { "title": "Use All Vehicles", "type": "boolean" }, "multi_dispatch": { "title": "Multi Dispatch", "type": "boolean" }, "max_num_dispatches": { "title": "Max Num Dispatches", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "capabilities": { "title": "Capabilities", "type": "array", "items": { "type": "string" } }, "start_depot_store_location_ids": { "title": "Start Depot Store Location Ids", "type": "array", "items": { "type": "string" } }, "end_depot_store_location_ids": { "title": "End Depot Store Location Ids", "type": "array", "items": { "type": "string" } } }, "description": "The approval-bound subset of one vehicle type's configuration." }, "ProofOfDeliverySerializer": { "title": "ProofOfDeliverySerializer", "required": [ "type" ], "type": "object", "properties": { "type": { "title": "Type", "type": "string", "description": "Type of proof of delivery, e.g., 'photo', 'signature', etc." }, "url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "URL of the proof of delivery document.", "default": null }, "uploadedAt": { "title": "Uploadedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the proof of delivery was uploaded.", "default": null } }, "description": "Delivery tracking details for an order at a route stop." }, "ProviderConfigInputSerializer": { "title": "ProviderConfigInputSerializer", "required": [ "provider", "serviceType" ], "type": "object", "properties": { "provider": { "title": "Provider", "type": "string", "description": "Provider name", "example": "X" }, "serviceType": { "title": "Servicetype", "type": "string", "description": "Service type (e.g., pick_and_deliver, marketplace)", "example": "pick_and_deliver" }, "categories": { "title": "Categories", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Provider-specific categories for this product", "default": null, "example": [ "Produce", "Fruits", "Organic" ] }, "imageUrls": { "title": "Imageurls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Provider-specific image URLs for this product. When set, these override the product-level image_urls for this provider.", "default": null, "example": [ "https://example.com/bananas-dd1.jpg", "https://example.com/bananas-dd2.jpg" ] }, "enabled": { "title": "Enabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this provider config is enabled", "default": null, "example": true } } }, "ProviderConfigOutputSerializer": { "title": "ProviderConfigOutputSerializer", "required": [ "provider", "serviceType" ], "type": "object", "properties": { "provider": { "title": "Provider", "type": "string", "description": "Provider name", "example": "X" }, "serviceType": { "title": "Servicetype", "type": "string", "description": "Service type (e.g., pick_and_deliver, marketplace)", "example": "pick_and_deliver" }, "categories": { "title": "Categories", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Provider-specific categories for this product", "default": null, "example": [ "Produce", "Fruits", "Organic" ] }, "imageUrls": { "title": "Imageurls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Provider-specific image URLs for this product. When set, these override the product-level image_urls for this provider.", "default": null, "example": [ "https://example.com/bananas-dd1.jpg", "https://example.com/bananas-dd2.jpg" ] }, "enabled": { "title": "Enabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether this provider config is enabled", "default": null, "example": true } } }, "QuoteSerializer": { "title": "QuoteSerializer", "required": [ "id", "providerId", "providerName", "createdTime", "priceCents" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Quote ID", "example": "qot_01234567890" }, "type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Quote type", "default": null }, "providerId": { "title": "Providerid", "type": "string", "description": "Provider ID", "example": "uber_standard_mini_mart" }, "providerName": { "title": "Providername", "type": "string", "description": "Provider name", "example": "Nash" }, "providerLogo": { "title": "Providerlogo", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider logo", "default": null, "example": "https://nash.com/logo.png" }, "providerIsInternal": { "title": "Providerisinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Is the provider internal", "default": null }, "createdTime": { "title": "Createdtime", "type": "string", "description": "Created time", "example": "2021-01-01T00:00:00Z" }, "expireTime": { "title": "Expiretime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Expire time", "default": null, "example": "2021-01-01T00:00:00Z" }, "priceCents": { "title": "Pricecents", "type": "integer", "description": "Price in cents", "example": 1000 }, "taxAmountCents": { "title": "Taxamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tax amount in cents", "default": null, "example": 100 }, "tollFeeCents": { "title": "Tollfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Toll fee in cents", "default": null, "example": 100 }, "nashFeeCents": { "title": "Nashfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Nash fee in cents", "default": null, "example": 100 }, "insuranceFeeCents": { "title": "Insurancefeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Insurance fee in cents", "default": null, "example": 100 }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Currency", "default": null, "example": "USD" }, "pickupWindow": { "title": "Pickupwindow", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup window", "default": null, "example": "2021-01-01T00:00:00Z" }, "dropoffEta": { "title": "Dropoffeta", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff ETA", "default": null, "example": "2021-01-01T00:00:00Z" }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Tags", "default": null, "example": [ "tag1", "tag2", "autodispatch_preferred_quote" ] }, "costSplitCustomerCents": { "title": "Costsplitcustomercents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cost split customer in cents", "default": null, "example": 100 }, "costSplitBusinessCents": { "title": "Costsplitbusinesscents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cost split business in cents", "default": null, "example": 100 }, "totalPriceBreakdown": { "title": "Totalpricebreakdown", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Total price breakdown", "default": null, "example": { "subtotal": 1000, "tax": 100, "total": 1100 } }, "totalPriceCents": { "title": "Totalpricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Total price in cents", "default": null, "example": 1000 }, "rank": { "title": "Rank", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Quote rank for preferred provider ordering", "default": null, "example": 1 }, "price": { "title": "Price", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Price", "default": null, "example": 1000 }, "isSuccessful": { "title": "Issuccessful", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Is successful", "default": null, "example": true }, "errorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error message", "default": null, "example": "Error message" }, "errorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Machine-readable quote failure code", "default": null, "example": "unsupported_package_requirements" }, "errorDetails": { "title": "Errordetails", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Structured quote failure details", "default": null, "example": { "unsupported_requirements": [ "alcohol" ] } } }, "description": "Generic serializer for quotes used in many endpoints." }, "RankedProvider": { "title": "RankedProvider", "required": [ "providerId", "parentProviderId", "providerName", "probability", "rank" ], "type": "object", "properties": { "providerId": { "title": "Providerid", "type": "string" }, "parentProviderId": { "title": "Parentproviderid", "type": "string" }, "providerName": { "title": "Providername", "type": "string" }, "probability": { "title": "Probability", "type": "number" }, "rank": { "title": "Rank", "type": "integer" } } }, "ReassignTaskInputSerializer": { "title": "ReassignTaskInputSerializer", "type": "object", "properties": { "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "New pickup start time", "default": null, "example": "2021-01-01T00:00:00Z" }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "New pickup end time", "default": null, "example": "2021-01-01T00:15:00Z" }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "New dropoff start time", "default": null, "example": "2021-01-01T00:30:00Z" }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "New dropoff end time", "default": null, "example": "2021-01-01T01:00:00Z" }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "enum": [ "now", "scheduled" ], "type": "string" }, { "type": "null" } ], "description": "New package delivery mode.", "default": null, "example": "now" } }, "description": "Body for reassign task endpoint." }, "RebookJobBody": { "title": "RebookJobBody", "type": "object", "properties": { "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Pickup start time", "default": null }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Pickup end time", "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Dropoff start time", "default": null }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Dropoff end time", "default": null } }, "description": "Body for rebook job endpoint." }, "RecipientType": { "title": "RecipientType", "enum": [ "courier", "customer", "pickup_business" ], "type": "string", "description": "Enum for message recipient types." }, "RefreshBatchQuotesOutputSerializer": { "title": "RefreshBatchQuotesOutputSerializer", "required": [ "jobId", "quotes" ], "type": "object", "properties": { "jobId": { "title": "Jobid", "type": "string" }, "quotes": { "title": "Quotes", "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" } } }, "description": "Expected output after refreshing quotes for a batch job." }, "RefreshOrderQuotesInput": { "title": "RefreshOrderQuotesInput", "type": "object", "properties": { "orderId": { "title": "Orderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The id of the order to refresh quotes for", "default": null, "example": "ord_1234567890" }, "externalOrderId": { "title": "Externalorderid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the order to refresh quotes for", "default": null, "example": "ext_1234567890" } }, "description": "Input for refreshing quotes for an order." }, "RefreshOrderQuotesOutputExample": { "title": "RefreshOrderQuotesOutputExample", "required": [ "quotes" ], "type": "object", "properties": { "quotes": { "title": "Quotes", "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" }, "description": "The quotes of the order", "example": [ { "costSplitBusinessCents": null, "costSplitCustomerCents": null, "createdTime": "2024-09-03T20:43:45.899094", "currency": "USD", "dropoffEta": "2024-09-03T22:20:47.569000", "expireTime": "2024-09-03T21:43:45.899102", "id": "qot_2oWASjGxMtucwGgu6A7BYC", "insuranceFeeCents": 0, "nashFeeCents": 300, "pickupWindow": null, "priceCents": 100, "providerId": "dispatch_partner", "providerIsInternal": false, "providerLogo": "https://nash-provider-logos.s3.amazonaws.com/dispatchit-logo.jpg", "providerName": "Dispatch", "tags": null, "taxAmountCents": null, "tollFeeCents": 0, "totalPriceBreakdown": { "priceCents": 100 }, "totalPriceCents": 100, "type": "LOCAL" } ] } } }, "RefreshQuotesOutputSerializer": { "title": "RefreshQuotesOutputSerializer", "required": [ "jobId", "quotes" ], "type": "object", "properties": { "jobId": { "title": "Jobid", "type": "string", "description": "Job ID", "example": "job_01234567890" }, "quotes": { "title": "Quotes", "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" }, "description": "Quotes" } }, "description": "Expected output for refreshing quotes." }, "RefundRequestParams": { "title": "RefundRequestParams", "required": [ "statuses" ], "type": "object", "properties": { "statuses": { "title": "Statuses", "type": "array", "items": { "enum": [ "under_review", "needs_attention", "cancelled", "approved", "denied", "nash_approved" ], "type": "string" } } } }, "RefundRequestResponse": { "title": "RefundRequestResponse", "required": [ "id", "createdAt", "jobId", "taskId", "organizationId", "incidentSubtype", "incidentNotes", "status", "refundAmountCents", "refundAmountDeliveryFeeCents", "refundAmountOrderValueCents", "refundAmountTipCents", "currency", "response", "proofOfRefund", "requestAmountCents", "requestAmountDeliveryFeeCents", "requestAmountOrderValueCents", "requestAmountTipCents" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the refund request.", "example": "rfrq_01234567890123456789" }, "createdAt": { "title": "Createdat", "type": "string", "description": "The date and time when the refund request was created.", "example": "2023-08-29T19:17:46.264523" }, "resolutionDate": { "title": "Resolutiondate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The date and time when the refund request was resolved (status changed to approved, denied, cancelled, or nash_approved).", "default": null, "example": "2023-08-30T14:30:00.000000" }, "jobId": { "title": "Jobid", "type": "string", "description": "The job this refund request is associated with.", "example": "job_01234567890123456789" }, "taskId": { "title": "Taskid", "type": "string", "description": "The task this refund request is associated with.", "example": "tsk_01234567890123456789" }, "organizationId": { "title": "Organizationid", "type": "string", "description": "The ID of the organization.", "example": "org_01234567890123456789" }, "incidentSubtype": { "title": "Incidentsubtype", "type": "string", "description": "The subtype of the incident." }, "incidentNotes": { "title": "Incidentnotes", "type": "string", "description": "Notes about the incident from the merchant." }, "status": { "title": "Status", "anyOf": [ { "$ref": "#/components/schemas/RefundStatus" }, { "type": "string" } ], "description": "The status of the refund request.", "example": "approved" }, "refundAmountCents": { "title": "Refundamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The total requested refund amount.", "example": 11500 }, "refundAmountDeliveryFeeCents": { "title": "Refundamountdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The requested refund amount for the delivery fee.", "example": 1000 }, "refundAmountOrderValueCents": { "title": "Refundamountordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The requested refund amount for the order value.", "example": 10000 }, "refundAmountTipCents": { "title": "Refundamounttipcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The requested refund amount for the tip.", "example": 500 }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency of the refund request.", "example": "USD" }, "response": { "title": "Response", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The response from the courier." }, "proofOfRefund": { "title": "Proofofrefund", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The supporting evidence for the refund." }, "requestAmountCents": { "title": "Requestamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the delivery fee, order value, and tip in cents.", "example": 11500 }, "requestAmountDeliveryFeeCents": { "title": "Requestamountdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the delivery fee in cents.", "example": 1000 }, "requestAmountOrderValueCents": { "title": "Requestamountordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the order value in cents.", "example": 10000 }, "requestAmountTipCents": { "title": "Requestamounttipcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The request amount for the tip in cents.", "example": 500 } }, "description": "Response for refund request." }, "RefundRequestType": { "title": "RefundRequestType", "enum": [ "arrived_late", "delivered_early", "delivered_to_wrong_address", "missing_or_incorrect_items", "never_delivered", "poor_delivery_experience", "other" ], "type": "string" }, "RefundStatus": { "title": "RefundStatus", "enum": [ 1, 2, 3, 4, 5, 6, 7 ], "type": "integer" }, "RemovedDispatchPlanOrders": { "title": "RemovedDispatchPlanOrders", "required": [ "planId", "revision", "contentHash", "activeMemberCount", "removedOrderIds" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "contentHash": { "title": "Contenthash", "type": "string" }, "activeMemberCount": { "title": "Activemembercount", "type": "integer" }, "removedOrderIds": { "title": "Removedorderids", "type": "array", "items": { "type": "string" } } } }, "RerunSummary": { "title": "RerunSummary", "required": [ "activity_id", "unassigned_order_ids", "plan_summary", "seconds_taken" ], "type": "object", "properties": { "activity_id": { "title": "Activity Id", "type": "string" }, "unassigned_order_ids": { "title": "Unassigned Order Ids", "type": "array", "items": { "type": "string" } }, "plan_summary": { "title": "Plan Summary", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" } }, "seconds_taken": { "title": "Seconds Taken", "type": "number" } }, "description": "One fresh solve of a stored payload." }, "ResolveReading": { "title": "ResolveReading", "enum": [ "not_the_change", "change_caused_drop", "partly_reproduced", "change_causes_other_drops", "inconsistent", "not_reproduced" ], "type": "string", "description": "What the fresh solves show. Declaration order is the order in which the rules apply." }, "ResolveResult": { "title": "ResolveResult", "required": [ "status" ], "type": "object", "properties": { "schema_version": { "title": "Schema Version", "type": "string", "default": "unassigned-resolve/v1", "const": "unassigned-resolve/v1" }, "status": { "$ref": "#/components/schemas/ResolveStatus" }, "reading": { "anyOf": [ { "$ref": "#/components/schemas/ResolveReading" }, { "type": "null" } ], "default": null }, "recorded_new_drops": { "title": "Recorded New Drops", "type": "array", "items": { "type": "string" }, "default": [] }, "previous_activity_id": { "title": "Previous Activity Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "previous_rerun": { "anyOf": [ { "$ref": "#/components/schemas/RerunSummary" }, { "type": "null" } ], "default": null }, "current_rerun": { "anyOf": [ { "$ref": "#/components/schemas/RerunSummary" }, { "type": "null" } ], "default": null }, "queued_at": { "title": "Queued At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "solved_at": { "title": "Solved At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "error": { "title": "Error", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "ResolveStatus": { "title": "ResolveStatus", "enum": [ "pending", "done", "failed", "no_new_drops", "no_previous_run", "input_missing", "unsupported_solver", "not_comparable", "not_requested" ], "type": "string" }, "ReturnedBatchJobMixin": { "title": "ReturnedBatchJobMixin", "required": [ "id", "createdAt", "portalUrl", "isActive", "isBatch", "batch", "route", "jobConfigurations" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Job ID", "example": "job_01234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "Created at", "example": "2023-08-29T19:17:46.264523" }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "Portal URL", "example": "https://usenash.com/portal/job_abc123" }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier", "default": null, "example": "mini-mart-order-99" }, "jobMetadata": { "title": "Jobmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Job metadata", "default": null, "example": { "key": "value" } }, "isActive": { "title": "Isactive", "type": "boolean", "description": "Is the job active", "example": true }, "isBatch": { "title": "Isbatch", "type": "boolean", "description": "Is the job a batch", "example": false }, "batch": { "$ref": "#/components/schemas/BatchSerializer", "description": "Batch" }, "route": { "anyOf": [ { "$ref": "#/components/schemas/RouteSerializer" }, { "type": "null" } ], "description": "Route" }, "jobConfigurations": { "title": "Jobconfigurations", "type": "array", "items": { "$ref": "#/components/schemas/JobConfigurationsSerializer" }, "description": "Job configurations" }, "optionsGroup": { "anyOf": [ { "$ref": "#/components/schemas/OptionsGroupSerializer" }, { "type": "null" } ], "description": "Options group", "default": null }, "shortReferenceCode": { "title": "Shortreferencecode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Short, non-unique human-readable reference code for the job.", "default": null } }, "description": "The format for a returned batch job used in many endpoints." }, "ReturnedJobMixin": { "title": "ReturnedJobMixin", "required": [ "id", "createdAt", "portalUrl", "isActive", "isBatch", "jobConfigurations" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Job ID", "example": "job_01234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "Created at", "example": "2023-08-29T19:17:46.264523" }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "Portal URL", "example": "https://usenash.com/portal/job_abc123" }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier", "default": null, "example": "mini-mart-order-99" }, "jobMetadata": { "title": "Jobmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Job metadata", "default": null, "example": { "key": "value" } }, "isActive": { "title": "Isactive", "type": "boolean", "description": "Is the job active", "example": true }, "isBatch": { "title": "Isbatch", "type": "boolean", "description": "Is the job a batch", "example": false }, "jobConfigurations": { "title": "Jobconfigurations", "type": "array", "items": { "$ref": "#/components/schemas/JobConfigurationsSerializer" }, "description": "Job configurations" }, "optionsGroup": { "anyOf": [ { "$ref": "#/components/schemas/OptionsGroupSerializer" }, { "type": "null" } ], "description": "Options group", "default": null }, "shortReferenceCode": { "title": "Shortreferencecode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "7-digit non-unique human-readable reference code for the job.", "default": null, "example": "0123456" }, "selectedConfiguration": { "title": "Selectedconfiguration", "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/TaskSerializer" } } }, { "type": "null" } ], "description": "Selected configuration", "default": null, "example": { "tasks": [] }, "deprecated": true }, "jobSpecification": { "title": "Jobspecification", "anyOf": [ { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/PackageSerializer" } } }, { "type": "null" } ], "description": "Job specification", "default": null, "example": { "packages": [] }, "deprecated": true }, "route": { "anyOf": [ { "$ref": "#/components/schemas/RouteSerializer" }, { "type": "null" } ], "description": "Route", "default": null } }, "description": "A Nash Job." }, "RoleIds": { "title": "RoleIds", "required": [ "roleIds" ], "type": "object", "properties": { "roleIds": { "title": "Roleids", "type": "array", "items": { "type": "string" } } } }, "RoleRead": { "title": "RoleRead", "required": [ "id", "name", "organizationId" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "organizationId": { "title": "Organizationid", "type": "string" } } }, "RolesListResponse": { "title": "RolesListResponse", "required": [ "roles" ], "type": "object", "properties": { "roles": { "title": "Roles", "type": "array", "items": { "$ref": "#/components/schemas/RoleRead" } } } }, "RotateWidgetEmbedCredentialBody": { "title": "RotateWidgetEmbedCredentialBody", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Label for the replacement. Defaults to the outgoing name.", "default": null }, "overlap_minutes": { "title": "Overlap Minutes", "minimum": 0.0, "type": "integer", "description": "How long the outgoing credential keeps working. 0 retires it immediately.", "default": 60 } }, "additionalProperties": false }, "RouteListCourierRead": { "title": "RouteListCourierRead", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "RouteListPageRead": { "title": "RouteListPageRead", "required": [ "results", "totalCount", "limit", "offset" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/RouteListRead" } }, "totalCount": { "title": "Totalcount", "type": "integer" }, "limit": { "title": "Limit", "type": "integer" }, "offset": { "title": "Offset", "type": "integer" } } }, "RouteListRead": { "title": "RouteListRead", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "createdAt": { "title": "Createdat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "updatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "portalUrl": { "title": "Portalurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "providerName": { "title": "Providername", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "courier": { "anyOf": [ { "$ref": "#/components/schemas/RouteListCourierRead" }, { "type": "null" } ], "default": null }, "vehicle": { "anyOf": [ { "$ref": "#/components/schemas/RouteListVehicleRead" }, { "type": "null" } ], "default": null }, "stopCount": { "title": "Stopcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "orderIds": { "title": "Orderids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "distanceMeters": { "title": "Distancemeters", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "durationSeconds": { "title": "Durationseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null } } }, "RouteListVehicleRead": { "title": "RouteListVehicleRead", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "RouteRestrictionCreate": { "title": "RouteRestrictionCreate", "required": [ "name", "polygons" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "polygons": { "title": "Polygons", "type": "array", "items": { "type": "array", "items": { "maxItems": 2, "minItems": 2, "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] } } }, "restriction_metadata": { "title": "Restriction Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null } } }, "RouteRestrictionRead": { "title": "RouteRestrictionRead", "required": [ "id", "organization_id", "name", "coverage_area_id", "polygons" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "organization_id": { "title": "Organization Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "coverage_area_id": { "title": "Coverage Area Id", "type": "string" }, "polygons": { "title": "Polygons", "type": "array", "items": { "type": "array", "items": { "maxItems": 2, "minItems": 2, "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] } } }, "restriction_metadata": { "title": "Restriction Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null }, "optimization_strategy_ids": { "title": "Optimization Strategy Ids", "type": "array", "items": { "type": "string" }, "default": [] } } }, "RouteRestrictionUpdate": { "title": "RouteRestrictionUpdate", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "polygons": { "title": "Polygons", "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "maxItems": 2, "minItems": 2, "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] } } }, { "type": "null" } ], "default": null }, "restriction_metadata": { "title": "Restriction Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null } } }, "RouteRestrictionsListResponse": { "title": "RouteRestrictionsListResponse", "required": [ "route_restrictions" ], "type": "object", "properties": { "route_restrictions": { "title": "Route Restrictions", "type": "array", "items": { "$ref": "#/components/schemas/RouteRestrictionRead" } } } }, "RouteSerializer": { "title": "RouteSerializer", "required": [ "id", "portalUrl", "type", "stops" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Unique identifier for the route.", "example": "rte_JphRWDiEosGpXuxwgaYfY3" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External Route ID.", "default": null, "example": "rte_JphRWDiEosGpXuxwgaYfY3" }, "portalUrl": { "title": "Portalurl", "type": "string", "description": "Portal URL of the route.", "example": "https://portal.usenash.com/routes/rte_JphRWDiEosGpXuxwgaYfY3" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the route.", "default": null, "example": "Route 1" }, "type": { "title": "Type", "type": "string", "description": "Type of the route, indicating the pickup/dropoff structure.", "example": "SINGLE_PICKUP_MULTIPLE_DROPOFFS" }, "courierId": { "title": "Courierid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier ID of the driver assigned to the route.", "default": null, "example": "cor_9dK2mNp7xVt3RfWzY8sLbQ" }, "vehicleId": { "title": "Vehicleid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vehicle ID of the vehicle assigned to the route.", "default": null, "example": "veh_4hL8pXq2sVn6RtY3wCbD9M" }, "courier": { "anyOf": [ { "$ref": "#/components/schemas/CourierSerializer" }, { "type": "null" } ], "description": "Courier/driver details for the route.", "default": null }, "driverGroup": { "anyOf": [ { "$ref": "#/components/schemas/DriverGroupSerializer" }, { "type": "null" } ], "description": "Driver group assigned to the route.", "default": null }, "courierPosition": { "anyOf": [ { "$ref": "#/components/schemas/CourierPositionSerializer" }, { "type": "null" } ], "description": "Current GPS position of the assigned courier.", "default": null }, "vehicle": { "anyOf": [ { "$ref": "#/components/schemas/VehicleSerializer" }, { "type": "null" } ], "description": "Vehicle details for the route.", "default": null }, "providerName": { "title": "Providername", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the delivery provider assigned to this route.", "default": null }, "shiftId": { "title": "Shiftid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shift ID of the shift assigned to the route.", "default": null, "example": "shf_1234567890abcdef12345678" }, "stops": { "title": "Stops", "type": "array", "items": { "$ref": "#/components/schemas/RouteStopSerializer" }, "description": "Ordered list of stops included in the route." }, "isDispatched": { "title": "Isdispatched", "type": "boolean", "description": "Whether the route is dispatched.", "default": false }, "jobId": { "title": "Jobid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dispatched Job ID of this route", "default": null, "example": "job_1234567890abcdef12345678" }, "routeMetadata": { "title": "Routemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Additional metadata for the route.", "default": null, "example": { "priority": "high", "source": "optimization_engine" } }, "validationErrors": { "title": "Validationerrors", "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "Validation errors for the route.", "default": null, "example": { "order_123": "Order 123 has pickup but no dropoff" } }, "encodedPolyline": { "title": "Encodedpolyline", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Encoded polyline representing the route geometry.", "default": null }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Current status of the route.", "default": null, "example": "CREATED" }, "statusHistory": { "title": "Statushistory", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, { "type": "null" } ], "description": "History of status changes for the route.", "default": null, "example": [ { "created_at": "2025-04-25T03:00:00Z", "status": "CREATED" }, { "created_at": "2025-04-25T03:10:00Z", "status": "ASSIGNED" }, { "created_at": "2025-04-25T03:15:00Z", "status": "STARTED" } ] } }, "description": "Represents a planned sequence of stops for a delivery or batch." }, "RouteStatus": { "title": "RouteStatus", "enum": [ "created", "assigned", "started", "in_progress", "completed", "failed", "canceled" ], "type": "string", "description": "Status enum for Routes." }, "RouteStatusTransitionParams": { "title": "RouteStatusTransitionParams", "type": "object", "properties": { "routeStatus": { "anyOf": [ { "$ref": "#/components/schemas/RouteStatus" }, { "type": "null" } ], "description": "Fire only when a route transitions INTO this status. Omit to fire on every transition.", "default": null }, "routeStatuses": { "title": "Routestatuses", "anyOf": [ { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/RouteStatus" } }, { "type": "null" } ], "description": "Fire only when a route transitions into one of these statuses. Omit to fire on every transition; an empty list is rejected (the handler treats a falsy list as no scope, so an empty list would silently fire on every transition rather than none).", "default": null } } }, "RouteStopInputSerializer": { "title": "RouteStopInputSerializer", "required": [ "stopType", "objectIds" ], "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Stable id for this stop. If provided, it is preserved across upserts; if omitted, it is carried forward by matching stop_type + object_ids against the route's current stops, or a new one is minted.", "default": null, "example": "stp_Qr5bVt8WiByGh66z2g7xEu" }, "stopType": { "title": "Stoptype", "type": "string", "description": "Type of the stop.", "example": "PICKUP" }, "objectIds": { "title": "Objectids", "type": "array", "items": { "type": "string" }, "description": "List of object IDs (e.g., order IDs, store location IDs, break IDs) associated with this stop.", "example": [ "ord_Qr5bVt8WiByGh66z2g7xEu" ] }, "serviceTime": { "title": "Servicetime", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Service time at the stop in seconds.", "default": null, "example": 300 }, "distanceFromPrevious": { "title": "Distancefromprevious", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Distance from the previous stop in meters.", "default": null, "example": 1500 }, "durationFromPrevious": { "title": "Durationfromprevious", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Travel duration from the previous stop in seconds.", "default": null, "example": 420 }, "arrivalTime": { "title": "Arrivaltime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Planned arrival time at the stop (UTC).", "default": null, "example": "2025-04-25T03:27:00Z" }, "departTime": { "title": "Departtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Planned departure time from the stop (UTC).", "default": null, "example": "2025-04-25T03:30:00Z" }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LatLngSerializer" }, { "type": "null" } ], "description": "Geographic location of the stop. Required for most stop types except breaks.", "default": null }, "metadata": { "title": "Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Additional metadata for this stop.", "default": null, "example": { "priority": "high" } } }, "description": "Input for a single route stop." }, "RouteStopSerializer": { "title": "RouteStopSerializer", "required": [ "stopType", "objectIds", "location" ], "type": "object", "properties": { "stopType": { "title": "Stoptype", "type": "string", "description": "Type of the stop.", "example": "PICKUP" }, "objectIds": { "title": "Objectids", "type": "array", "items": { "type": "string" }, "description": "List of object IDs (e.g., order IDs, store location IDs) associated with this stop.", "example": [ "ord_Qr5bVt8WiByGh66z2g7xEu", "ord_WJFuooSiRvFCaceGZjpbqs" ] }, "arrivalTime": { "title": "Arrivaltime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Estimated arrival time at the stop (UTC).", "default": null, "example": "2025-04-25T03:27:00" }, "departTime": { "title": "Departtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Estimated departure time from the stop (UTC).", "default": null, "example": "2025-04-25T03:30:00" }, "plannedArrivalTime": { "title": "Plannedarrivaltime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Snapshot of arrival_time captured pre-dispatch (UTC). Mirrors arrival_time while the route is undispatched, then freezes at dispatch \u2014 gives consumers the planned ETA at dispatch even after real-time tracking updates arrival_time.", "default": null, "example": "2025-04-25T03:27:00" }, "serviceTime": { "title": "Servicetime", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Estimated service time spent at the stop (in seconds).", "default": null, "example": 360 }, "distanceFromPrevious": { "title": "Distancefromprevious", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Distance traveled from the previous stop (in meters).", "default": null, "example": 3376 }, "durationFromPrevious": { "title": "Durationfromprevious", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Travel duration from the previous stop (in seconds).", "default": null, "example": 420 }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LatLngSerializer" }, { "type": "null" } ], "description": "Geographic location of the stop. Can be null for non-location based stops like breaks." }, "status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Current status of the stop.", "default": null, "example": "PENDING" }, "statusDescription": { "title": "Statusdescription", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Detailed description of the current status of the stop.", "default": null, "example": "leave_unattended" }, "statusHistory": { "title": "Statushistory", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, { "type": "null" } ], "description": "History of status changes for the stop.", "default": null, "example": [ { "created_at": "2025-04-25T03:00:00Z", "status": "PENDING" }, { "created_at": "2025-04-25T03:15:00Z", "status": "ENROUTE" }, { "created_at": "2025-04-25T03:20:00Z", "status": "COMPLETED", "status_description": "leave_unattended" } ] }, "metadata": { "title": "Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Additional metadata for this stop.", "default": null }, "startedAt": { "title": "Startedat", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Timestamp when the stop entered IN_PROGRESS status (UTC).", "default": null, "example": "2025-04-25T03:27:00Z" }, "breakDuration": { "title": "Breakduration", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Duration in seconds of the break at this stop (for DRIVER_BREAK stops).", "default": null }, "orders": { "title": "Orders", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/StopOrderSerializer" } }, { "type": "null" } ], "description": "Orders associated with this stop, including tracking URLs and delivery details.", "default": null } }, "description": "Represents a single stop within a planned route." }, "RunRef": { "title": "RunRef", "required": [ "activity_id", "completed_at", "solver", "result_cached" ], "type": "object", "properties": { "activity_id": { "title": "Activity Id", "type": "string" }, "completed_at": { "title": "Completed At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "solver": { "title": "Solver", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "result_cached": { "title": "Result Cached", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } } }, "SelectQuoteInputSerializer": { "title": "SelectQuoteInputSerializer", "required": [ "quoteId" ], "type": "object", "properties": { "quoteId": { "title": "Quoteid", "type": "string", "description": "Unique reference number for the quote that should be selected to create a job and start a delivery", "example": "qot_01234567890" } }, "description": "Expected input for selecting a quote." }, "SelectQuoteOutputSerializer": { "title": "SelectQuoteOutputSerializer", "required": [ "job" ], "type": "object", "properties": { "job": { "title": "Job", "anyOf": [ { "$ref": "#/components/schemas/ReturnedJobMixin" }, { "$ref": "#/components/schemas/ReturnedBatchJobMixin" } ] } }, "description": "Expected output when selecting a quote for a task, batch , order." }, "SelectTaskQuoteOutputSerializer": { "title": "SelectTaskQuoteOutputSerializer", "required": [ "job", "jobId" ], "type": "object", "properties": { "job": { "$ref": "#/components/schemas/ReturnedJobMixin", "description": "Job" }, "jobId": { "title": "Jobid", "type": "string", "description": "Job ID", "example": "job_01234567890" }, "task": { "anyOf": [ { "$ref": "#/components/schemas/TaskSerializer" }, { "type": "null" } ], "description": "Task", "default": null }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/DeliverySerializer" }, { "type": "null" } ], "description": "Delivery", "default": null }, "quote": { "anyOf": [ { "$ref": "#/components/schemas/QuoteSerializer" }, { "type": "null" } ], "description": "Quote", "default": null } }, "description": "Expected output when selecting a quote." }, "SendMessageInput": { "title": "SendMessageInput", "required": [ "order_id", "recipient_type", "message_type", "message" ], "type": "object", "properties": { "order_id": { "title": "Order Id", "type": "string" }, "recipient_type": { "$ref": "#/components/schemas/RecipientType" }, "message_type": { "$ref": "#/components/schemas/MessageType" }, "message": { "title": "Message", "type": "string" } } }, "SetStrategyRestrictionsRequest": { "title": "SetStrategyRestrictionsRequest", "required": [ "route_restriction_ids" ], "type": "object", "properties": { "route_restriction_ids": { "title": "Route Restriction Ids", "type": "array", "items": { "type": "string" } } } }, "SetStrategyRestrictionsResponse": { "title": "SetStrategyRestrictionsResponse", "required": [ "route_restrictions" ], "type": "object", "properties": { "route_restrictions": { "title": "Route Restrictions", "type": "array", "items": { "$ref": "#/components/schemas/RouteRestrictionRead" } } } }, "SetWorkflowStatusSerializer": { "title": "SetWorkflowStatusSerializer", "required": [ "status" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/WorkflowStatus" } } }, "ShiftBreakConfigurationInput": { "title": "ShiftBreakConfigurationInput", "required": [ "timeWindow", "breakDuration" ], "type": "object", "properties": { "timeWindow": { "title": "Timewindow", "maxItems": 2, "minItems": 2, "type": "array", "prefixItems": [ { "type": "number" }, { "type": "number" } ] }, "breakDuration": { "title": "Breakduration", "exclusiveMinimum": 0.0, "type": "number" } }, "additionalProperties": false, "description": "One optimization break window, in minutes measured from the start of the shift.\n\nField names mirror the legacy `BreakConfigurationInput` so a caller can send the same\n`optimizationParams` payload to either shift mutation.\n\n`time_window` is required and `max_working_time` is absent on purpose. `BreakConfiguration`\ntreats the two as mutually exclusive and raises when both are set, and `init_breaks` sorts\nthe list on `time_window[0]` \u2014 so a window-less entry (which the legacy input accepts) dies\non a bare `TypeError` inside the optimizer's parser instead of returning a typed error.\nConstraining the input to the only shape that actually parses is what keeps every value this\nschema admits convertible by `to_optimization_params_dict`." }, "ShiftOptimizationParamsInput": { "title": "ShiftOptimizationParamsInput", "type": "object", "properties": { "serviceTimeRelativeEfficiency": { "title": "Servicetimerelativeefficiency", "anyOf": [ { "exclusiveMinimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null }, "plannedBreaks": { "title": "Plannedbreaks", "maxItems": 20, "type": "array", "items": { "$ref": "#/components/schemas/ShiftBreakConfigurationInput" } }, "breakConfig": { "anyOf": [ { "$ref": "#/components/schemas/BreakConfig" }, { "type": "null" } ], "default": null }, "departureDelay": { "title": "Departuredelay", "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null }, "shiftEndServiceTimeMinutes": { "title": "Shiftendservicetimeminutes", "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null }, "vehicleConfig": { "anyOf": [ { "$ref": "#/components/schemas/ShiftVehicleConfigInput" }, { "type": "null" } ], "default": null } }, "additionalProperties": false, "description": "Typed replacement for the free-form `optimization_params` blob.\n\nEvery value this schema admits converts cleanly through `ShiftOptimizationParams`, which\nstays the single normalization authority \u2014 `to_optimization_params_dict` delegates to it\nrather than re-deriving the stored shape, so a snapshot replayed unchanged keeps comparing\nequal to what a previous request persisted." }, "ShiftRead": { "title": "ShiftRead", "required": [ "id", "organization_id", "status" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "organization_id": { "title": "Organization Id", "type": "string" }, "external_id": { "title": "External Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "route_id": { "title": "Route Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "store_location_id": { "title": "Store Location Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "zone_ids": { "title": "Zone Ids", "type": "array", "items": { "type": "string" } }, "courier_id": { "title": "Courier Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "vehicle_id": { "title": "Vehicle Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "$ref": "#/components/schemas/ShiftStatus" }, "timezone_id": { "title": "Timezone Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "planned_start": { "title": "Planned Start", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "planned_end": { "title": "Planned End", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "actual_start": { "title": "Actual Start", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "actual_end": { "title": "Actual End", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "planned_breaks": { "title": "Planned Breaks", "type": "array", "items": { "$ref": "#/components/schemas/PlannedBreakWindow" } }, "taken_break_count": { "title": "Taken Break Count", "type": "integer", "default": 0 }, "vehicle_config": { "anyOf": [ { "$ref": "#/components/schemas/ShiftVehicleConfig" }, { "type": "null" } ], "default": null } } }, "ShiftResponse": { "title": "ShiftResponse", "required": [ "id", "name", "plannedStart", "plannedEnd", "status", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the shift." }, "name": { "title": "Name", "type": "string", "description": "The name of the shift." }, "plannedStart": { "title": "Plannedstart", "type": "string", "description": "The planned start timestamp of the shift." }, "plannedEnd": { "title": "Plannedend", "type": "string", "description": "The planned end timestamp of the shift." }, "plannedBreakDuration": { "title": "Plannedbreakduration", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The planned break duration of the shift.", "default": null }, "shiftMetadata": { "title": "Shiftmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the shift.", "default": null }, "optimizationParams": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParams" }, { "type": "null" } ], "description": "The optimization parameters of the shift.", "default": null }, "status": { "title": "Status", "type": "string", "description": "The status of the shift." }, "storeLocationId": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The store location ID of the shift.", "default": null }, "externalStoreLocationId": { "title": "Externalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external store location ID of the shift.", "default": null }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The zone IDs of the shift.", "default": null }, "externalZoneIds": { "title": "Externalzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The external zone IDs of the shift.", "default": null }, "courierId": { "title": "Courierid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The courier ID of the shift.", "default": null }, "vehicleId": { "title": "Vehicleid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The vehicle ID of the shift.", "default": null }, "createdAt": { "title": "Createdat", "type": "string", "description": "The creation timestamp of the shift." }, "updatedAt": { "title": "Updatedat", "type": "string", "description": "The update timestamp of the shift." } }, "description": "Response for shift." }, "ShiftStatus": { "title": "ShiftStatus", "enum": [ "PLANNED", "ACTIVE", "INACTIVE", "ON_BREAK", "COMPLETED", "CANCELLED" ], "type": "string" }, "ShiftUpsertInput": { "title": "ShiftUpsertInput", "required": [ "external_id", "planned_start", "planned_end" ], "type": "object", "properties": { "external_id": { "title": "External Id", "maxLength": 255, "minLength": 1, "type": "string" }, "status": { "$ref": "#/components/schemas/ShiftStatus", "default": "PLANNED" }, "store_location_id": { "title": "Store Location Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "zone_ids": { "title": "Zone Ids", "maxItems": 100, "type": "array", "items": { "type": "string" } }, "courier_id": { "title": "Courier Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "vehicle_id": { "title": "Vehicle Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "name": { "title": "Name", "anyOf": [ { "maxLength": 320, "type": "string" }, { "type": "null" } ], "default": null }, "planned_start": { "title": "Planned Start", "type": "string", "format": "date-time" }, "planned_end": { "title": "Planned End", "type": "string", "format": "date-time" }, "planned_break_duration": { "title": "Planned Break Duration", "maximum": 1439, "minimum": 0.0, "type": "integer", "default": 0 }, "optimization_params": { "anyOf": [ { "$ref": "#/components/schemas/ShiftOptimizationParamsInput" }, { "type": "null" } ], "default": null }, "shift_metadata": { "title": "Shift Metadata", "type": "object", "additionalProperties": true } }, "additionalProperties": false, "description": "Complete planning snapshot keyed by the caller's organization-scoped id.\n\nThe snapshot is authoritative: every field the caller omits is persisted as its default,\nnot left at whatever a previous request stored. That is what makes an unchanged replay\ndetectable, and it is why `ShiftRepository.upsert_by_external_ids` refuses to apply a\nsnapshot to a shift that is already past its planning phase." }, "ShiftUpsertOutcome": { "title": "ShiftUpsertOutcome", "enum": [ "created", "updated", "unchanged" ], "type": "string" }, "ShiftUpsertReceipt": { "title": "ShiftUpsertReceipt", "required": [ "index", "external_id", "id", "outcome", "shift" ], "type": "object", "properties": { "index": { "title": "Index", "type": "integer" }, "external_id": { "title": "External Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "outcome": { "$ref": "#/components/schemas/ShiftUpsertOutcome" }, "shift": { "$ref": "#/components/schemas/ShiftRead" } } }, "ShiftVehicleConfig": { "title": "ShiftVehicleConfig", "type": "object", "properties": { "vehicle_profile": { "title": "Vehicle Profile", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "speed_factor": { "title": "Speed Factor", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "parking_time": { "title": "Parking Time", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null } }, "description": "The optimization-relevant vehicle settings a shift carries.\n\nDerived from `shift_metadata.optimization_params.vehicle_config`, which is where Coles\nkeeps them and where the main optimize path reads them from. Only the fields a re-solve or\nre-time needs; `speed_factor` and `parking_time` (hours) keep travel times honest. HERE truck\ndimensions deliberately do not come from here \u2014 the shift's raw weight/length fields carry\ntheir own units, and the original solve reads dimensions from the contract." }, "ShiftVehicleConfigInput": { "title": "ShiftVehicleConfigInput", "type": "object", "properties": { "weight": { "title": "Weight", "type": "integer", "default": 0 }, "height": { "title": "Height", "type": "integer", "default": 0 }, "length": { "title": "Length", "type": "integer", "default": 0 }, "width": { "title": "Width", "type": "integer", "default": 0 }, "axleCount": { "title": "Axlecount", "type": "integer", "default": 0 }, "trailerCount": { "title": "Trailercount", "type": "integer", "default": 0 }, "weightUnit": { "title": "Weightunit", "enum": [ "kg", "lbs" ], "type": "string", "default": "kg" }, "lengthUnit": { "title": "Lengthunit", "enum": [ "meter", "in" ], "type": "string", "default": "meter" }, "maxStops": { "title": "Maxstops", "minimum": 0.0, "type": "integer", "default": 0 }, "maxOrdersAtOnce": { "title": "Maxordersatonce", "minimum": 0.0, "type": "integer", "default": 0 }, "maxDistance": { "title": "Maxdistance", "minimum": 0.0, "type": "integer", "default": 0 }, "maxDuration": { "title": "Maxduration", "minimum": 0.0, "type": "integer", "default": 0 }, "speedFactor": { "title": "Speedfactor", "exclusiveMinimum": 0.0, "type": "number", "default": 1.0 }, "capabilities": { "title": "Capabilities", "maxItems": 100, "type": "array", "items": { "type": "string" } }, "fixedCost": { "title": "Fixedcost", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "costPerUnitDistance": { "title": "Costperunitdistance", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "costPerUnitTime": { "title": "Costperunittime", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "vehicleProfile": { "title": "Vehicleprofile", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "minOrdersPerRoute": { "title": "Minordersperroute", "anyOf": [ { "minimum": 0.0, "type": "integer" }, { "type": "null" } ], "default": null }, "parkingTime": { "title": "Parkingtime", "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null } }, "additionalProperties": false, "description": "Per-shift vehicle overrides. Field names and defaults mirror `nash.vehicles.VehicleConfig`." }, "ShippingDetails": { "title": "ShippingDetails", "type": "object", "properties": { "providerId": { "title": "Providerid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider that will fulfil this order's shipment.", "default": null }, "providerConsignmentId": { "title": "Providerconsignmentid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider consignment ID for this order's shipment.", "default": null }, "providerExternalId": { "title": "Providerexternalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider-assigned tracking/identifier for this order (formerly tracking_number).", "default": null }, "speed": { "title": "Speed", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delivery speed for this order (e.g. 'STANDARD', 'EXPRESS', 'same_day').", "default": null, "example": "STANDARD" }, "type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Shipment type for this order (provider-specific, e.g. 'NEUTRAL').", "default": null, "example": "NEUTRAL" }, "movementType": { "title": "Movementtype", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider movement type for this shipment (e.g. 'DESPATCH').", "default": null, "example": "DESPATCH" }, "chargeAccountId": { "title": "Chargeaccountid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Charge account to bill this shipment against.", "default": null }, "sortCode": { "title": "Sortcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Identifier for the warehouse load/run this shipment belongs to (e.g. Pet Circle WMS sort code).", "default": null, "example": "PCLOAD-01" } }, "description": "Per-order shipping attributes applied when manifesting." }, "SizeSpecificationInputSerializer": { "title": "SizeSpecificationInputSerializer", "type": "object", "properties": { "value": { "title": "Value", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The size value", "default": null, "example": 100.0 }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the size specification", "default": null, "example": "Large" } } }, "SizeSpecificationOutputSerializer": { "title": "SizeSpecificationOutputSerializer", "type": "object", "properties": { "value": { "title": "Value", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The size value", "default": null, "example": 100.0 }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Description of the size specification", "default": null, "example": "Large" } } }, "SpeedBand": { "title": "SpeedBand", "required": [ "mph" ], "type": "object", "properties": { "min_miles": { "title": "Min Miles", "minimum": 0.0, "type": "number", "default": 0 }, "mph": { "title": "Mph", "exclusiveMinimum": 0.0, "type": "number" } } }, "StartDispatchPlanOptimization": { "title": "StartDispatchPlanOptimization", "required": [ "expectedRevision" ], "type": "object", "properties": { "expectedRevision": { "title": "Expectedrevision", "minimum": 0.0, "type": "integer", "description": "The `revision` of the plan you last read." }, "params": { "$ref": "#/components/schemas/DispatchPlanOptimizationParams" } }, "additionalProperties": false }, "StatusTriggeredTooEarlyParams": { "title": "StatusTriggeredTooEarlyParams", "required": [ "metricValue", "deliveryStatus" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" }, "deliveryStatus": { "title": "Deliverystatus", "minLength": 1, "type": "string" } } }, "StatusesChangedTooQuicklyParams": { "title": "StatusesChangedTooQuicklyParams", "required": [ "metricValue", "deliveryStatus1", "deliveryStatus2" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" }, "metricName": { "title": "Metricname", "type": "string", "default": "seconds", "const": "seconds" }, "deliveryStatus1": { "title": "Deliverystatus1", "minLength": 1, "type": "string" }, "deliveryStatus2": { "title": "Deliverystatus2", "minLength": 1, "type": "string" } } }, "StopOrderSerializer": { "title": "StopOrderSerializer", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Order ID.", "example": "ord_Qr5bVt8WiByGh66z2g7xEu" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier for the order.", "default": null }, "publicTrackingUrl": { "title": "Publictrackingurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Public tracking URL for the order.", "default": null }, "pod": { "title": "Pod", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ProofOfDeliverySerializer" } }, { "type": "null" } ], "description": "Proof of delivery data (photos, signature, etc.) if captured.", "default": null }, "orderItems": { "title": "Orderitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemSerializer" } }, { "type": "null" } ], "description": "Items with lifecycle status tracking (picked, delivered, failed, etc.).", "default": null } }, "description": "Order information associated with a route stop." }, "StoreInventoryDetailsInputSerializer": { "title": "StoreInventoryDetailsInputSerializer", "type": "object", "properties": { "weightedItemInfo": { "anyOf": [ { "$ref": "#/components/schemas/StoreInventoryWeightedItemInfoInputSerializer" }, { "type": "null" } ], "description": "Weight information per inventory item", "default": null }, "taxPercentage": { "title": "Taxpercentage", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Tax rate as a decimal (e.g., 0.1 for 10%)", "default": null, "example": 0.1 } } }, "StoreInventoryDetailsOutputSerializer": { "title": "StoreInventoryDetailsOutputSerializer", "type": "object", "properties": { "weightedItemInfo": { "anyOf": [ { "$ref": "#/components/schemas/StoreInventoryWeightedItemInfoOutputSerializer" }, { "type": "null" } ], "description": "Weight information per inventory item", "default": null }, "taxPercentage": { "title": "Taxpercentage", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Tax rate as a decimal (e.g., 0.1 for 10%)", "default": null, "example": 0.1 } } }, "StoreInventoryInputSerializer": { "title": "StoreInventoryInputSerializer", "required": [ "available" ], "type": "object", "properties": { "externalProductId": { "title": "Externalproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external product ID from an external system", "default": null, "example": "ext_001" }, "externalStoreLocationId": { "title": "Externalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external store ID from an external system", "default": null, "example": "store_001" }, "quantity": { "title": "Quantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the product in stock", "default": null, "example": 50 }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price of the product in cents", "default": null, "example": 299 }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency code for the product price", "default": null, "example": "USD" }, "available": { "title": "Available", "type": "boolean", "description": "Whether the product is available for purchase", "example": true }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LocationDataInputSerializer" }, { "type": "null" } ], "description": "The location data for the product in the store", "default": null, "example": { "aisle": "Produce", "bay": "Fruits", "shelf": "Bananas" } }, "details": { "anyOf": [ { "$ref": "#/components/schemas/StoreInventoryDetailsInputSerializer" }, { "type": "null" } ], "description": "Additional inventory details", "default": null, "example": { "weightedItemInfo": { "valueCentsPerMeasurementUnit": 120 } } }, "providerConfigs": { "title": "Providerconfigs", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/InventoryProviderConfigInputSerializer" } }, { "type": "null" } ], "description": "Provider-specific configurations for this inventory item", "default": null, "example": [ { "currency": "USD", "details": { "weightedItemInfo": { "valueCentsPerMeasurementUnit": 135 } }, "discount": { "endTime": "2025-12-17T00:00:00Z", "startTime": "2025-12-10T00:00:00Z", "valueCents": 270 }, "provider": "X", "serviceType": "pick_and_deliver", "valueCents": 299 } ] } } }, "StoreInventoryListInputSerializer": { "title": "StoreInventoryListInputSerializer", "required": [ "inventory" ], "type": "object", "properties": { "inventory": { "title": "Inventory", "type": "array", "items": { "$ref": "#/components/schemas/StoreInventoryInputSerializer" }, "description": "List of store inventory to create or update" } } }, "StoreInventoryListOutputSerializer": { "title": "StoreInventoryListOutputSerializer", "type": "array", "items": { "$ref": "#/components/schemas/StoreInventoryUpsertRowSerializer" }, "description": "`POST /v1/inventory` response: one entry per processed row, upserted or skipped." }, "StoreInventoryOutputSerializer": { "title": "StoreInventoryOutputSerializer", "required": [ "id", "productId", "storeLocationId", "quantity", "available" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "productId": { "title": "Productid", "type": "string", "description": "The product ID associated with this inventory item", "example": "prod_123" }, "externalProductId": { "title": "Externalproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external product ID from an external system", "default": null, "example": "ext_001" }, "storeLocationId": { "title": "Storelocationid", "type": "string", "description": "The store location ID where this inventory is located", "example": "store_001" }, "externalStoreLocationId": { "title": "Externalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external store ID from an external system", "default": null, "example": "ext_store_002" }, "quantity": { "title": "Quantity", "type": "integer", "description": "The quantity of the product in stock", "example": 50 }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price of the product in cents", "default": null, "example": 299 }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency code for the product price", "default": null, "example": "USD" }, "available": { "title": "Available", "type": "boolean", "description": "Whether the product is available for purchase", "example": true }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LocationDataOutputSerializer" }, { "type": "null" } ], "description": "The location data for the product in the store", "default": null, "example": { "aisle": "Produce", "bay": "Fruits", "shelf": "Bananas" } }, "details": { "anyOf": [ { "$ref": "#/components/schemas/StoreInventoryDetailsOutputSerializer" }, { "type": "null" } ], "description": "Additional inventory details", "default": null, "example": { "weightedItemInfo": { "valueCentsPerMeasurementUnit": 120 } } }, "providerConfigs": { "title": "Providerconfigs", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/InventoryProviderConfigOutputSerializer" } }, { "type": "null" } ], "description": "Provider-specific configurations for this inventory item", "default": null, "example": [ { "currency": "USD", "details": { "weightedItemInfo": { "valueCentsPerMeasurementUnit": 135 } }, "discount": { "endTime": "2025-12-17T00:00:00Z", "startTime": "2025-12-10T00:00:00Z", "valueCents": 270 }, "provider": "X", "serviceType": "pick_and_deliver", "valueCents": 299 } ] } } }, "StoreInventoryUpsertRowSerializer": { "title": "StoreInventoryUpsertRowSerializer", "required": [ "id", "productId", "externalProductId", "storeLocationId", "externalStoreLocationId", "quantity", "available", "errorCode", "errorMessage" ], "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Null when the row was skipped.", "example": "inv_123" }, "productId": { "title": "Productid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The product ID associated with this inventory item. Null when the row was skipped.", "example": "prod_123" }, "externalProductId": { "title": "Externalproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external product ID from an external system", "example": "ext_001" }, "storeLocationId": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The store location ID where this inventory is located. Null when the row was skipped.", "example": "store_001" }, "externalStoreLocationId": { "title": "Externalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external store ID from an external system", "example": "ext_store_002" }, "quantity": { "title": "Quantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the product in stock. Null when the row was skipped.", "example": 50 }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price of the product in cents", "default": null, "example": 299 }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The currency code for the product price", "default": null, "example": "USD" }, "available": { "title": "Available", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the product is available for purchase. Null when the row was skipped.", "example": true }, "location": { "anyOf": [ { "$ref": "#/components/schemas/LocationDataOutputSerializer" }, { "type": "null" } ], "description": "The location data for the product in the store", "default": null, "example": { "aisle": "Produce", "bay": "Fruits", "shelf": "Bananas" } }, "details": { "anyOf": [ { "$ref": "#/components/schemas/StoreInventoryDetailsOutputSerializer" }, { "type": "null" } ], "description": "Additional inventory details", "default": null }, "providerConfigs": { "title": "Providerconfigs", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/InventoryProviderConfigOutputSerializer" } }, { "type": "null" } ], "description": "Provider-specific configurations for this inventory item", "default": null }, "errorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Set when this row was skipped (unknown product or store location); null on success.", "example": "MISSING_RESOURCE" }, "errorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Why the row was skipped; null on success.", "example": "Product 'ext_001' not found." } }, "description": "One row of the `POST /v1/inventory` upsert response.\n\nA single uniform shape for both outcomes of an upsert row: on success the\ndata fields are populated and ``errorCode``/``errorMessage`` are null; a\nrow skipped for an unknown product or store location echoes the external\nIDs, sets ``errorCode``/``errorMessage``, and nulls everything else.\nDiscriminate on ``errorCode`` being non-null. Every field is emitted on\nevery row (required-but-nullable), so generated clients keep one DTO.\n\nDistinct from ``StoreInventoryOutputSerializer`` (the `GET /v1/inventory`\nrow), which never carries the error fields." }, "StoreInventoryWeightedItemInfoInputSerializer": { "title": "StoreInventoryWeightedItemInfoInputSerializer", "type": "object", "properties": { "valueCentsPerMeasurementUnit": { "title": "Valuecentspermeasurementunit", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price per cents per measurement unit", "default": null, "example": 120 } } }, "StoreInventoryWeightedItemInfoOutputSerializer": { "title": "StoreInventoryWeightedItemInfoOutputSerializer", "type": "object", "properties": { "valueCentsPerMeasurementUnit": { "title": "Valuecentspermeasurementunit", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price per cents per measurement unit", "default": null, "example": 120 } } }, "StoreLocationAddressResponse": { "title": "StoreLocationAddressResponse", "required": [ "street", "city", "country" ], "type": "object", "properties": { "number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number of the address.", "default": null, "example": "1600" }, "secondaryNumber": { "title": "Secondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The secondary number of the address.", "default": null, "example": null }, "street": { "title": "Street", "type": "string", "description": "The street of the address. If your geocoding service does not split numbers from street names, you can pass the street name with the number in this field. Example: 1600 Pennsylvania Avenue NW.", "example": "Pennsylvania Avenue NW" }, "county": { "title": "County", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county of the address.", "default": null, "example": "Washington" }, "city": { "title": "City", "type": "string", "description": "The city of the address.", "example": "Washington" }, "state": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the address.", "default": null, "example": "DC" }, "postalCode": { "title": "Postalcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The postal code of the address.", "default": null, "example": "20500" }, "country": { "title": "Country", "type": "string", "description": "The country of the address.", "example": "US" }, "latitude": { "title": "Latitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The latitude of the address.", "default": null, "example": 38.8948949 }, "longitude": { "title": "Longitude", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The longitude of the address.", "default": null, "example": -77.0371581 }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "IANA time zone of the store location.", "default": null } } }, "StoreLocationDayCapacityInputSerializer": { "title": "StoreLocationDayCapacityInputSerializer", "required": [ "storeLocationId", "date", "dayCapacity" ], "type": "object", "properties": { "storeLocationId": { "title": "Storelocationid", "type": "string", "description": "The store location for which to set capacity.", "example": "stl_1234567890" }, "date": { "title": "Date", "pattern": "(\\d{4})-(\\d{2})-(\\d{2})", "type": "string", "description": "The date for the specified capacity", "example": "2024-10-06" }, "dayCapacity": { "title": "Daycapacity", "type": "object", "additionalProperties": true, "description": "The capacity for the day.", "example": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } } } }, "description": "Expected payload for the set store location day capacity endpoint." }, "StoreLocationDefaultCapacityInputSerializer": { "title": "StoreLocationDefaultCapacityInputSerializer", "required": [ "storeLocationId", "defaultCapacity" ], "type": "object", "properties": { "storeLocationId": { "title": "Storelocationid", "type": "string", "description": "The store location for which to set capacity.", "example": "stl_1234567890" }, "defaultCapacity": { "title": "Defaultcapacity", "type": "object", "additionalProperties": true, "description": "The default weekly capacity.", "example": { "friday": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } }, "monday": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } }, "saturday": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } }, "sunday": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } }, "thursday": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } }, "tuesday": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } }, "wednesday": { "isActive": true, "shiftCapacity": { "00:00": 0, "01:00": 0, "02:00": 0, "03:00": 0, "04:00": 0, "05:00": 0, "06:00": 0, "07:00": 0, "08:00": 4, "09:00": 4, "10:00": 4, "11:00": 4, "12:00": 4, "13:00": 4, "14:00": 6, "15:00": 6, "16:00": 6, "17:00": 6, "18:00": 0, "19:00": 0, "20:00": 0, "21:00": 0, "22:00": 0, "23:00": 0 } } } } }, "description": "Expected payload for the set store location default capacity endpoint." }, "StoreLocationResponse": { "title": "StoreLocationResponse", "required": [ "id", "name", "phoneNumber", "location", "zoneIds", "zoneAssociations", "tags", "integrationMetadata" ], "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Store location unique identifier from an external system.", "default": null, "example": "40123" }, "operatingHours": { "title": "Operatinghours", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "[Integration Specific]: An object with keys that correspond to days of week (monday, tuesday, etc) and their corresponding operating hours / delivery windows.", "default": null, "example": { "friday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "monday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "saturday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "sunday": { "active": true, "shifts": [ [ "11:00", "18:00" ] ] }, "thursday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "tuesday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "wednesday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] } } }, "prepTimeMinutes": { "title": "Preptimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "[Integration Specific]: the preparation time to apply for orders, if relying on Nash to compute the delivery windows. This only applies to specific integrations.", "default": null }, "blackoutDates": { "title": "Blackoutdates", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The blackout dates of the store location.", "default": null, "example": [ "2024-01-01", "2024-01-02" ] }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Taylor" }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Swift" }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the person at the store location.", "default": null, "example": "taylor@swift.com" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The pickup instructions of the store location. Limited to 280 characters. Nash Recommended Input: Order [insert order number] for [insert customer name] from [business name]", "default": null, "example": "Once you arrive at the store, please click above to let us know you are here. Then, go ahead and find a sales associate inside - they'll be happy to help you!" }, "id": { "title": "Id", "type": "string", "description": "The ID of the store location.", "example": "stl_01234567890123456789" }, "name": { "title": "Name", "type": "string", "description": "The name of the store location.", "example": "White House" }, "phoneNumber": { "title": "Phonenumber", "type": "string", "description": "The phone number of the person at the store location.", "example": "+1234567890" }, "location": { "$ref": "#/components/schemas/StoreLocationAddressResponse", "description": "The location of the store location." }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The zone ids of the store location.", "example": [ "zone_01234567890123456789", "zone_01234567890123456789" ] }, "zoneAssociations": { "title": "Zoneassociations", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "The zone associations of the store location.", "example": [ { "end_date": "2025-01-01", "start_date": "2024-01-01", "store_location_id": "stl_01234567890123456789", "zone_id": "zone_01234567890123456789" } ] }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The tags of the store location.", "example": "['service:rapid', 'franchise_location']" }, "integrationMetadata": { "title": "Integrationmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The integration metadata of the store location.", "example": { "integration_name": "ABC" } } }, "description": "Response for store location." }, "StuckStatusParams": { "title": "StuckStatusParams", "required": [ "metricValue", "deliveryStatus" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" }, "metricName": { "title": "Metricname", "anyOf": [ { "enum": [ "hours", "minutes" ], "type": "string" }, { "type": "null" } ], "default": null }, "deliveryStatus": { "title": "Deliverystatus", "minLength": 1, "type": "string" }, "activateBeforePickup": { "title": "Activatebeforepickup", "type": "boolean", "default": false }, "metricValue2": { "title": "Metricvalue2", "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null }, "metricName2": { "title": "Metricname2", "anyOf": [ { "enum": [ "hours", "minutes" ], "type": "string" }, { "type": "null" } ], "default": null } } }, "SubItemInput": { "title": "SubItemInput", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The merchant ID of the item", "default": null, "example": "abc-123" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the item", "default": null, "example": "A box of books" }, "count": { "title": "Count", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the item", "default": null, "example": 2 }, "dimensions": { "anyOf": [ { "$ref": "#/components/schemas/Dimensions" }, { "type": "null" } ], "description": "The dimensions of the item", "default": null, "example": { "depth": 14, "height": 10, "width": 12 } }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The weight of the item in kilograms (kg)", "default": null, "example": 1.5 }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The value of the item in cents", "default": null, "example": 1000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of requirements for this item", "default": null, "example": [ "age_verification_on_delivery" ] }, "category": { "title": "Category", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The category of the item", "default": null }, "barcode": { "title": "Barcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Barcode value for this item.", "default": null, "example": "0199312650999998913643M221872801002010908" }, "metadata": { "title": "Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this item.", "default": null, "example": { "packaging_type": "CTN" } }, "sku": { "title": "Sku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The SKU of the sub-item", "default": null }, "substitution": { "anyOf": [ { "$ref": "#/components/schemas/SubstitutionObject" }, { "type": "null" } ], "description": "Substitution preferences for the sub-item", "default": null }, "subItems": { "title": "Subitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SubItemInput" } }, { "type": "null" } ], "description": "The nested sub-items", "default": null } }, "description": "Sub-item input object for API requests." }, "SubItemOutput": { "title": "SubItemOutput", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The merchant ID of the item", "default": null, "example": "abc-123" }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The description of the item", "default": null, "example": "A box of books" }, "count": { "title": "Count", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the item", "default": null, "example": 2 }, "dimensions": { "anyOf": [ { "$ref": "#/components/schemas/Dimensions" }, { "type": "null" } ], "description": "The dimensions of the item", "default": null, "example": { "depth": 14, "height": 10, "width": 12 } }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The weight of the item in kilograms (kg)", "default": null, "example": 1.5 }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The value of the item in cents", "default": null, "example": 1000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of requirements for this item", "default": null, "example": [ "age_verification_on_delivery" ] }, "category": { "title": "Category", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The category of the item", "default": null }, "barcode": { "title": "Barcode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Barcode value for this item.", "default": null, "example": "0199312650999998913643M221872801002010908" }, "metadata": { "title": "Metadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this item.", "default": null, "example": { "packaging_type": "CTN" } }, "sku": { "title": "Sku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The SKU of the sub-item", "default": null }, "substitution": { "anyOf": [ { "$ref": "#/components/schemas/SubstitutionObject" }, { "type": "null" } ], "description": "Substitution information for the sub-item", "default": null }, "subItems": { "title": "Subitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SubItemOutput" } }, { "type": "null" } ], "description": "The nested sub-items", "default": null } }, "description": "Sub-item object returned by the API." }, "SubstituteItemObject": { "title": "SubstituteItemObject", "type": "object", "properties": { "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the substitute item", "default": null }, "sku": { "title": "Sku", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The SKU of the substitute item", "default": null }, "quantity": { "title": "Quantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The quantity of the substitute item", "default": null } } }, "SubstitutionObject": { "title": "SubstitutionObject", "type": "object", "properties": { "preference": { "title": "Preference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "What to do when this item can't be picked: `refund`, `substitute`, or `contact` (the shopper contacts the customer to agree a substitution).", "default": null, "example": "substitute" }, "source": { "title": "Source", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Source of substitution, e.g., merchant, customer", "default": null }, "substituteItems": { "title": "Substituteitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SubstituteItemObject" } }, { "type": "null" } ], "description": "List of substitute items", "default": null } } }, "SuccessResponse": { "title": "SuccessResponse", "required": [ "success" ], "type": "object", "properties": { "success": { "title": "Success", "type": "boolean", "description": "Whether the operation was successful." } }, "description": "Representation of a success response." }, "TaskHealthStatusParams": { "title": "TaskHealthStatusParams", "required": [ "status", "healthStatus" ], "type": "object", "properties": { "status": { "title": "Status", "minLength": 1, "type": "string" }, "healthStatus": { "title": "Healthstatus", "minLength": 1, "type": "string" } } }, "TaskReassignmentParams": { "title": "TaskReassignmentParams", "required": [ "metricValue", "sendOnEveryTaskReassignment" ], "type": "object", "properties": { "metricValue": { "title": "Metricvalue", "type": "number" }, "metricName": { "title": "Metricname", "type": "string", "default": "number_of_times", "const": "number_of_times" }, "sendOnEveryTaskReassignment": { "title": "Sendoneverytaskreassignment", "type": "boolean" } } }, "TaskSerializer": { "title": "TaskSerializer", "required": [ "id", "createdAt", "status" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Task ID", "example": "tsk_01234567890" }, "createdAt": { "title": "Createdat", "type": "string", "description": "Created at", "example": "2023-08-29T19:17:46.264523" }, "status": { "title": "Status", "type": "string", "description": "Status", "example": "running" }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup start time", "default": null, "example": "2023-08-29T19:17:46.264523" }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup end time", "default": null, "example": "2023-08-29T19:17:46.264523" }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff start time", "default": null, "example": "2023-08-29T19:17:46.264523" }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff end time", "default": null, "example": "2023-08-29T19:17:46.264523" }, "providerId": { "title": "Providerid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Provider ID", "default": null, "example": "prv_01234567890" }, "providerIsInternal": { "title": "Providerisinternal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Provider is internal", "default": null, "example": true }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tip amount in cents", "default": null, "example": 100 }, "winnerQuote": { "title": "Winnerquote", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Winner quote", "default": null, "example": { "id": "qot_01234567890", "price_cents": 100 } }, "quotes": { "title": "Quotes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/QuoteSerializer" } }, { "type": "null" } ], "description": "Quotes", "default": null, "example": [ { "id": "qot_01234567890", "price_cents": 100 } ] }, "failedQuotes": { "title": "Failedquotes", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "Failed quotes", "default": null, "example": [ { "id": "qot_01234567890", "price_cents": 100 } ] }, "quoteFailure": { "title": "Quotefailure", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Summary when every provider rejects the package requirements", "default": null }, "delivery": { "anyOf": [ { "$ref": "#/components/schemas/DeliverySerializer" }, { "type": "null" } ], "description": "Delivery object", "default": null }, "tipAmountUsd": { "title": "Tipamountusd", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Tip amount in USD", "default": null, "example": 100.0 }, "failureCode": { "title": "Failurecode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Normalized delivery failure code", "default": null, "example": "age_verification_failed" }, "failureReason": { "title": "Failurereason", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Failure reason", "default": null, "example": "Task failed" }, "taskNotes": { "title": "Tasknotes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/NoteSerializer" } }, { "type": "null" } ], "description": "Task notes", "default": null, "example": [ { "created_at": "2023-08-29T19:17:46.264523", "id": "not_01234567890", "note": "Task note", "user": { "email": "john.doe@example.com" } } ] } }, "description": "Generic serializer for tasks used in many endpoints." }, "TemplateOutput": { "title": "TemplateOutput", "required": [ "id", "type", "payload", "externalId", "name", "startDatetime", "endDatetime", "daysOfWeek", "generationFrequencyValue", "generationFrequencyUnit", "createInstancesUpToValue", "createInstancesUpToUnit", "overrideExistingInstances" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the template.", "example": "tpl_01234567890123456789" }, "type": { "title": "Type", "type": "string", "description": "Template type (e.g., DELIVERY_WINDOW)", "example": "DELIVERY_WINDOW" }, "payload": { "title": "Payload", "type": "object", "additionalProperties": true, "description": "Required for templates" }, "externalId": { "title": "Externalid", "type": "string", "description": "External identifier for the template" }, "name": { "title": "Name", "type": "string", "description": "Name of the template" }, "startDatetime": { "title": "Startdatetime", "type": "string", "description": "The start datetime of the template.", "example": "2024-01-01T12:00:00" }, "endDatetime": { "title": "Enddatetime", "type": "string", "description": "The end datetime of the template.", "example": "2024-01-01T12:00:00" }, "daysOfWeek": { "title": "Daysofweek", "type": "array", "items": { "type": "string" }, "description": "Days of the week for template usage", "example": [ "MONDAY", "TUESDAY" ] }, "generationFrequencyValue": { "title": "Generationfrequencyvalue", "type": "integer", "description": "How often to create instances (value)", "example": 1 }, "generationFrequencyUnit": { "title": "Generationfrequencyunit", "type": "string", "description": "How often to create instances (unit)", "example": "DAY" }, "createInstancesUpToValue": { "title": "Createinstancesuptovalue", "type": "integer", "description": "How far into the future to create instances (value)", "example": 1 }, "createInstancesUpToUnit": { "title": "Createinstancesuptounit", "type": "string", "description": "How far into the future to create instances (unit)", "example": "DAY" }, "overrideExistingInstances": { "title": "Overrideexistinginstances", "type": "boolean", "description": "Whether to overwrite existing instances", "example": true } }, "description": "Response for a delivery window." }, "TemplatesResponse": { "title": "TemplatesResponse", "required": [ "templates" ], "type": "object", "properties": { "templates": { "title": "Templates", "type": "array", "items": { "$ref": "#/components/schemas/TemplateOutput" } } }, "description": "Response for a list of templates." }, "TestWorkflowSerializer": { "title": "TestWorkflowSerializer", "type": "object", "properties": { "jobId": { "title": "Jobid", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Job ID to build the workflow context from. Provide jobId or orderId (or both).", "default": null }, "orderId": { "title": "Orderid", "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Order ID to build the workflow context from. Provide jobId or orderId (or both).", "default": null }, "live": { "title": "Live", "type": "boolean", "description": "When false (default) the run is a dry run: filters are evaluated against the real entity and every action returns a preview without performing it (ai_decision follows uncertain). When true, messaging actions (send_slack, send_email, send_sms) are performed with content prefixed by [Test], and ai_decision sends its expanded question and context to Typesafe and follows the selected branch. All other actions remain preview-only.", "default": false } } }, "TimeElapsedSinceStatusParams": { "title": "TimeElapsedSinceStatusParams", "required": [ "deliveryStatus", "deliveryStatusArray" ], "type": "object", "properties": { "checkAfterMinutes": { "title": "Checkafterminutes", "anyOf": [ { "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "default": null }, "deliveryStatus": { "title": "Deliverystatus", "minLength": 1, "type": "string" }, "statusCondition": { "title": "Statuscondition", "enum": [ "in", "not_in" ], "type": "string", "default": "not_in" }, "deliveryStatusArray": { "title": "Deliverystatusarray", "type": "array", "items": { "type": "string" } } } }, "TransferDispatchPlanOrders": { "title": "TransferDispatchPlanOrders", "required": [ "expectedRevision", "selection", "destinationPlanId" ], "type": "object", "properties": { "expectedRevision": { "title": "Expectedrevision", "minimum": 0.0, "type": "integer", "description": "The `revision` of the plan you last read." }, "selection": { "$ref": "#/components/schemas/DispatchPlanSelection", "description": "The orders to move: named orders plus every order on the named draft routes." }, "destinationPlanId": { "title": "Destinationplanid", "minLength": 1, "type": "string", "description": "The plan the orders move to." } }, "additionalProperties": false }, "TransferredDispatchPlanOrders": { "title": "TransferredDispatchPlanOrders", "required": [ "planId", "revision", "contentHash", "activeMemberCount", "transfers", "destination" ], "type": "object", "properties": { "planId": { "title": "Planid", "type": "string" }, "revision": { "title": "Revision", "type": "integer" }, "contentHash": { "title": "Contenthash", "type": "string" }, "activeMemberCount": { "title": "Activemembercount", "type": "integer" }, "transfers": { "title": "Transfers", "type": "array", "items": { "$ref": "#/components/schemas/DispatchPlanTransfer" } }, "destination": { "$ref": "#/components/schemas/DispatchPlanTransferDestination" } } }, "TriggerAction": { "title": "TriggerAction", "required": [ "key" ], "type": "object", "properties": { "key": { "$ref": "#/components/schemas/ActionKey", "description": "Action key." }, "fields": { "title": "Fields", "type": "array", "items": { "type": "string" }, "description": "Wire fields that configure this action." } }, "description": "An action type that can be configured on a notification trigger." }, "TriggerCatalogEntry": { "title": "TriggerCatalogEntry", "required": [ "type", "title", "value", "entityType", "category" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/NotificationTriggerSlug", "description": "Stable trigger slug (e.g. 'route_status_transition'). Closed set; see enum." }, "title": { "title": "Title", "type": "string", "description": "Human-readable title." }, "value": { "$ref": "#/components/schemas/NotificationTriggerType", "description": "Pipe-delimited subscription id used by agent executions (closed set; one per trigger)." }, "entityType": { "$ref": "#/components/schemas/TriggerEntityType", "description": "Primary entity this trigger relates to." }, "category": { "$ref": "#/components/schemas/TriggerEntityType", "description": "Coarse grouping (currently the entity type)." }, "isFlag": { "title": "Isflag", "type": "boolean", "description": "Whether this is a flag-style trigger.", "default": false }, "creatable": { "title": "Creatable", "type": "boolean", "description": "Whether an agent can create this trigger via POST /v1/notification-triggers. False for system-generated triggers (e.g. route execution exceptions) that have no create variant \u2014 its parametersSchema is empty for that reason, not because it takes no parameters.", "default": false }, "description": { "title": "Description", "type": "string", "description": "Description of when the trigger fires.", "default": "" }, "statuses": { "title": "Statuses", "type": "array", "items": { "$ref": "#/components/schemas/EntityStatus" }, "description": "The exact valid on_statuses for THIS trigger (subset of the EntityStatus enum); empty for non status-transition triggers." }, "parametersSchema": { "title": "Parametersschema", "type": "object", "additionalProperties": true, "description": "JSON Schema of this trigger's create parameters." }, "supportedActions": { "title": "Supportedactions", "type": "array", "items": { "$ref": "#/components/schemas/ActionKey" }, "description": "Action keys this trigger supports." }, "supportedFilters": { "title": "Supportedfilters", "type": "array", "items": { "$ref": "#/components/schemas/FilterCriterionKey" }, "description": "Filter-criteria keys this trigger supports." } }, "description": "A single trigger type in the notification trigger catalog." }, "TriggerEntityType": { "title": "TriggerEntityType", "enum": [ "route", "delivery", "task", "order", "activity", "conversation", "unknown" ], "type": "string", "description": "Primary entity a trigger relates to." }, "TriggerNotificationInputSerializer": { "title": "TriggerNotificationInputSerializer", "required": [ "jobId" ], "type": "object", "properties": { "jobId": { "title": "Jobid", "type": "string", "description": "The job ID to trigger the notification for" } } }, "TriggerNotificationOutputSerializer": { "title": "TriggerNotificationOutputSerializer", "required": [ "notificationTrigger" ], "type": "object", "properties": { "notificationTrigger": { "$ref": "#/components/schemas/NotificationTriggerOutputSerializer", "description": "The triggered notification" } } }, "TriggerWorkflowSerializer": { "title": "TriggerWorkflowSerializer", "type": "object", "properties": { "jobId": { "title": "Jobid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Legacy. Use entity_refs instead.", "default": null }, "entityRefs": { "title": "Entityrefs", "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "Entity type to ID mapping. Supported types: order, job, delivery, task, route.", "default": null, "example": { "order": "ord_xxx" } }, "input": { "title": "Input", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Arbitrary JSON payload accessible in workflow templates via {{ trigger_metadata. }}.", "default": null }, "sync": { "title": "Sync", "type": "boolean", "description": "Run the workflow synchronously and return the completed result.", "default": false } } }, "UnassignedCause": { "title": "UnassignedCause", "enum": [ "capabilities_violation_only", "fewer_vans", "vehicle_constraint_tightened", "configuration_changed", "dropped_order_changed", "demand_added", "other_orders_changed", "demand_removed", "vehicle_constraint_loosened", "more_vans", "no_input_change" ], "type": "string", "description": "Cause classes. Declaration order is the order in which the rules apply, except that for an order the\nprevious run routed, a matching fleet rule (`fewer_vans`, `vehicle_constraint_tightened`) ranks above\n`capabilities_violation_only`." }, "UnassignedComparison": { "title": "UnassignedComparison", "required": [ "outcome", "current_run", "previous_run", "dropped_orders", "newly_dropped_order_ids", "carried_over_order_ids", "orders", "vehicles", "breaks", "configuration", "loosening_changes", "causes", "primary_cause", "recent_fleet", "blind_spots" ], "type": "object", "properties": { "schema_version": { "title": "Schema Version", "type": "string", "default": "unassigned-comparison/v1", "const": "unassigned-comparison/v1" }, "outcome": { "$ref": "#/components/schemas/ComparisonOutcome" }, "current_run": { "$ref": "#/components/schemas/RunRef" }, "previous_run": { "anyOf": [ { "$ref": "#/components/schemas/RunRef" }, { "type": "null" } ] }, "dropped_orders": { "title": "Dropped Orders", "type": "array", "items": { "$ref": "#/components/schemas/DroppedOrder" } }, "newly_dropped_order_ids": { "title": "Newly Dropped Order Ids", "type": "array", "items": { "type": "string" } }, "carried_over_order_ids": { "title": "Carried Over Order Ids", "type": "array", "items": { "type": "string" } }, "orders": { "anyOf": [ { "$ref": "#/components/schemas/OrdersDiff" }, { "type": "null" } ] }, "vehicles": { "anyOf": [ { "$ref": "#/components/schemas/VehiclesDiff" }, { "type": "null" } ] }, "breaks": { "title": "Breaks", "type": "array", "items": { "$ref": "#/components/schemas/BreakChange" } }, "configuration": { "anyOf": [ { "$ref": "#/components/schemas/ConfigurationDiff" }, { "type": "null" } ] }, "loosening_changes": { "title": "Loosening Changes", "type": "array", "items": { "$ref": "#/components/schemas/FieldChange" } }, "causes": { "title": "Causes", "type": "array", "items": { "$ref": "#/components/schemas/CauseMatch" } }, "primary_cause": { "anyOf": [ { "$ref": "#/components/schemas/UnassignedCause" }, { "type": "null" } ] }, "recent_fleet": { "title": "Recent Fleet", "type": "array", "items": { "$ref": "#/components/schemas/FleetPoint" } }, "blind_spots": { "title": "Blind Spots", "type": "array", "items": { "type": "string" } } } }, "UpdateDeliveryWindowInputSerializer": { "title": "UpdateDeliveryWindowInputSerializer", "required": [ "id" ], "type": "object", "properties": { "startTime": { "title": "Starttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The start time of the delivery window.", "default": null, "example": "2024-01-01T10:00:00Z" }, "startTimeLocal": { "title": "Starttimelocal", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The start time of the delivery window in local timezone.", "default": null, "example": "2024-01-01T10:00:00" }, "endTime": { "title": "Endtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The end time of the delivery window.", "default": null, "example": "2024-01-01T12:00:00Z" }, "endTimeLocal": { "title": "Endtimelocal", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The end time of the delivery window in local timezone.", "default": null, "example": "2024-01-01T12:00:00" }, "cutoffTime": { "title": "Cutofftime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The cutoff time of the delivery window.", "default": null, "example": "2024-01-01T10:00:00Z" }, "cutoffTimeLocal": { "title": "Cutofftimelocal", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "The cutoff time of the delivery window in local timezone.", "default": null, "example": "2024-01-01T10:00:00" }, "timezoneId": { "title": "Timezoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The timezone id of the delivery window.", "default": null, "example": "America/New_York" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the delivery window.", "default": null, "example": "Monday Delivery Window" }, "rrule": { "title": "Rrule", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The rrule of the delivery window.", "default": null, "example": "RRULE:FREQ=WEEKLY;BYDAY=MO" }, "exceptionDates": { "title": "Exceptiondates", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The exception dates of the delivery window.", "default": null, "example": [ "2024-01-01", "2024-01-02" ] }, "allowedTags": { "title": "Allowedtags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The allowed tags of the delivery window.", "default": null, "example": [ "service:rapid", "service:express", "franchise_location" ] }, "leadTimeMinutes": { "title": "Leadtimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The lead time of the delivery window.", "default": null, "example": 60 }, "priceCents": { "title": "Pricecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The price of the delivery window.", "default": null, "example": 1000 }, "minimumOrderValueCents": { "title": "Minimumordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The minimum order value of the delivery window.", "default": null, "example": 1000 }, "maximumCapacity": { "title": "Maximumcapacity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum capacity of the delivery window.", "default": null, "example": 1000 }, "storeLocationId": { "title": "Storelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The store location id of the delivery window.", "default": null, "example": "stl_01234567890123456789" }, "zoneId": { "title": "Zoneid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zone id of the delivery window.", "default": null, "example": "zone_01234567890123456789" }, "zoneExternalId": { "title": "Zoneexternalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external zone id of the delivery window.", "default": null, "example": "ext_01234567890123456789" }, "windowMetadata": { "title": "Windowmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the delivery window.", "default": null, "example": { "key": "value" } }, "isActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the delivery window is active.", "default": null, "example": true }, "isDeleted": { "title": "Isdeleted", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the delivery window is deleted.", "default": null, "example": false }, "id": { "title": "Id", "type": "string", "description": "The id of the delivery window.", "example": "dw_01234567890123456789" } }, "description": "Expected payload for updating a delivery window." }, "UpdateDeliveryWindowsInputSerializer": { "title": "UpdateDeliveryWindowsInputSerializer", "required": [ "deliveryWindows" ], "type": "object", "properties": { "deliveryWindows": { "title": "Deliverywindows", "type": "array", "items": { "$ref": "#/components/schemas/UpdateDeliveryWindowInputSerializer" } } }, "description": "Expected payload for updating multiple delivery windows." }, "UpdateJobInputSerializer": { "title": "UpdateJobInputSerializer", "type": "object", "properties": { "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup address", "default": null }, "pickupAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup phone number", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup first name", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup last name", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup email", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup instructions", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup store location ID", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff address", "default": null }, "dropoffAddressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff phone number", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff business name", "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff first name", "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff last name", "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff email", "default": null }, "dropoffStoreLocationId": { "title": "Dropoffstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff store location ID", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Dropoff instructions", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "packageDeliveryMode": { "title": "Packagedeliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Package delivery mode", "default": null }, "packagePickupStartTime": { "title": "Packagepickupstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "Package pickup start time", "default": null }, "packagePickupEndTime": { "title": "Packagepickupendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "Package pickup end time", "default": null }, "packageDropoffStartTime": { "title": "Packagedropoffstarttime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "Package dropoff start time", "default": null }, "packageDropoffEndTime": { "title": "Packagedropoffendtime", "anyOf": [ { "pattern": "(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2}).?(\\d)*Z?", "type": "string" }, { "type": "null" } ], "description": "Package dropoff end time", "default": null }, "packageDescription": { "title": "Packagedescription", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Package description", "default": null }, "packageRequirements": { "title": "Packagerequirements", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PackageRequirements" }, { "pattern": "^(custom|preferred):.*", "type": "string" } ] } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "packageMinimumVehicleSize": { "title": "Packageminimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Minimum vehicle size required for the package. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "packageValue": { "title": "Packagevalue", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Package value", "default": null }, "packageTax": { "title": "Packagetax", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Package tax", "default": null }, "tipAmount": { "title": "Tipamount", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Tip amount", "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Currency", "default": null }, "packageItems": { "title": "Packageitems", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "List of items in the package", "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reference ID", "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Items count", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "integer" }, { "type": "number" }, { "type": "null" } ], "description": "Package weight", "default": null }, "externalIdentifier": { "title": "Externalidentifier", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External identifier for the job", "default": null }, "jobMetadata": { "title": "Jobmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Job metadata", "default": null }, "packageMetadata": { "title": "Packagemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Package metadata", "default": null } }, "description": "Expected input for update job endpoint." }, "UpdateOptimizationStrategyInputSerializer": { "title": "UpdateOptimizationStrategyInputSerializer", "type": "object", "properties": { "optimizationSchedules": { "title": "Optimizationschedules", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/OptimizationScheduleInputSerializer" } }, { "type": "null" } ], "default": null }, "contractIds": { "title": "Contractids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Contracts considered during optimization.", "default": null }, "shiftContractId": { "title": "Shiftcontractid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Contract id of the provider supplying shifts for this strategy.", "default": null }, "pickupServiceTimeSeconds": { "title": "Pickupservicetimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "dropoffServiceTimeSeconds": { "title": "Dropoffservicetimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "incrementalServiceTimeSeconds": { "title": "Incrementalservicetimeseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "enableAutoDispatch": { "title": "Enableautodispatch", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "autodispatchWithinXMinutesOfPickupTime": { "title": "Autodispatchwithinxminutesofpickuptime", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.", "default": null }, "earliestDispatchMinutesBeforePickup": { "title": "Earliestdispatchminutesbeforepickup", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Deprecated. Use pickup_time_from_in_minutes / pickup_time_to_in_minutes.", "default": null }, "pickupTimeFromInMinutes": { "title": "Pickuptimefrominminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Lower bound (inclusive) of the pickup time window to optimize, in minutes from now.", "default": null }, "pickupTimeToInMinutes": { "title": "Pickuptimetoinminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Upper bound (exclusive) of the pickup time window to optimize, in minutes from now.", "default": null }, "contractOptimizationOverrideParameters": { "title": "Contractoptimizationoverrideparameters", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContractOverrideParametersSerializer" } }, { "type": "null" } ], "default": null }, "unassignedOrdersOptionsGroupId": { "title": "Unassignedordersoptionsgroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "defaultTrafficSource": { "title": "Defaulttrafficsource", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "trafficTimeOffsetWeeks": { "title": "Traffictimeoffsetweeks", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "avoidFerries": { "title": "Avoidferries", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Route around water crossings. Ferries are usually unusable by truck fleets, and the solver otherwise prices a sailing as ordinary driving time.", "default": null }, "minimizeZoneCrossings": { "title": "Minimizezonecrossings", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Prefer fewer crossings of selected zone polygons in LogisticsOS. Null disables the preference.", "default": null }, "communityZoneIds": { "title": "Communityzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Reusable zone references. Omit to preserve the selection; null or an empty list clears it.", "default": null }, "zones": { "title": "Zones", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zone ids assigned to this strategy.", "default": null }, "storeLocations": { "title": "Storelocations", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Store location ids assigned to this strategy.", "default": null }, "softCapabilities": { "title": "Softcapabilities", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "searchLevel": { "title": "Searchlevel", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "clusteringLevel": { "title": "Clusteringlevel", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "softClusterLabel": { "title": "Softclusterlabel", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "balanceRoutes": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationBalanceRoutes" }, { "type": "null" } ], "default": null }, "engineSolver": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationSolver" }, { "type": "null" } ], "default": null }, "saveOptimizedRoutes": { "title": "Saveoptimizedroutes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "dynamicCadenceConfig": { "anyOf": [ { "$ref": "#/components/schemas/DynamicCadenceConfigInputSerializer" }, { "type": "null" } ], "default": null }, "label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } } }, "UpdateOrderBulkPayload": { "title": "UpdateOrderBulkPayload", "required": [ "action", "data" ], "type": "object", "properties": { "action": { "title": "Action", "type": "string", "const": "update" }, "data": { "$ref": "#/components/schemas/UpdateOrderInput" } } }, "UpdateOrderInput": { "title": "UpdateOrderInput", "required": [ "id" ], "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order unique identifier from an external system.", "default": null }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null }, "pickupStoreLocationIds": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of store location IDs (internal or external) to consider for the Order. The optimal store will be selected and returned in the response in `pickupStoreLocationId` and/or `pickupStoreLocationExternalId`.", "default": null }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.", "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff. Limited to 280 characters.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values/types that are required to be scanned at the dropoff waypoint.", "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "'now' or 'scheduled' when the delivery should be scheduled", "default": null }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "deliveryWindowId": { "title": "Deliverywindowid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delivery window id if using Nash delivery windows", "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order description and notes. Limited to 280 characters.", "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of items in this order", "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local currency", "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Order value in cents", "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tip paid to the driver in cents", "default": null }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Set it to valueCents for a cash-on-delivery order and to 0 for a prepaid one; must not exceed valueCents. Omit when not applicable \u2014 providers then treat the order as prepaid. Forwarded to providers that support collect-on-delivery (currently Dash).", "default": null, "example": 10000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PackageRequirements" } }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order.\n\n Note: Best practice is to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this order.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Optional order tags, they will be included in every response", "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "The total weight of the package in kilograms (kg)", "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for weight: 'kg' or 'lbs'. Defaults to 'kg'. Weight is always stored in kg; a weight provided in 'lbs' is converted on ingest.", "default": null }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total height of the package in centimeters (cm)", "default": null }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total width of the package in centimeters (cm)", "default": null }, "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total depth of the package in centimeters (cm)", "default": null }, "volume": { "title": "Volume", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total volume of the package in cubic centimeters (cm^3)", "default": null }, "lengthUnit": { "title": "Lengthunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for height/width/depth and volume: 'cm' or 'in'. Defaults to 'cm'. Dimensions are always stored in cm (cm^3 for volume); values provided in 'in' (cubic inches for volume) are converted on ingest.", "default": null }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "Lists of items in the delivery", "default": null }, "optimizationParameters": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParameters" }, { "type": "null" } ], "description": "Order-level optimization parameters", "default": null }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null }, "reapplyAutomations": { "title": "Reapplyautomations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If set to true, the order will be re-evaluated with automations.", "default": null }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum delivery fee for the order in cents. This will override the dispatch strategy max delivery fee if both are set.", "default": null }, "id": { "title": "Id", "type": "string", "description": "The ID of the order" } } }, "UpdateRefundRequestInputSerializer": { "title": "UpdateRefundRequestInputSerializer", "type": "object", "properties": { "refundRequestId": { "title": "Refundrequestid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the refund request.", "default": null }, "providerDeliveryId": { "title": "Providerdeliveryid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the delivery.", "default": null }, "status": { "title": "Status", "enum": [ "under_review", "cancelled", "approved", "denied", "nash_approved", "draft", "needs_attention" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The status of the refund request.", "default": null }, "refundAmountCents": { "title": "Refundamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The total refund amount in cents.", "default": null }, "refundAmountDeliveryFeeCents": { "title": "Refundamountdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The refund amount for the delivery fee in cents.", "default": null }, "refundAmountOrderValueCents": { "title": "Refundamountordervaluecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The refund amount for the order value in cents.", "default": null }, "refundAmountTipCents": { "title": "Refundamounttipcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The refund amount for the tip in cents.", "default": null }, "response": { "title": "Response", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The response from the courier.", "default": null } } }, "UpdateStoreLocationInputSerializer": { "title": "UpdateStoreLocationInputSerializer", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Store location unique identifier from an external system.", "default": null, "example": "40123" }, "operatingHours": { "title": "Operatinghours", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "[Integration Specific]: An object with keys that correspond to days of week (monday, tuesday, etc) and their corresponding operating hours / delivery windows.", "default": null, "example": { "friday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "monday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "saturday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "sunday": { "active": true, "shifts": [ [ "11:00", "18:00" ] ] }, "thursday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "tuesday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] }, "wednesday": { "active": true, "shifts": [ [ "10:00", "19:00" ] ] } } }, "prepTimeMinutes": { "title": "Preptimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "[Integration Specific]: the preparation time to apply for orders, if relying on Nash to compute the delivery windows. This only applies to specific integrations.", "default": null }, "blackoutDates": { "title": "Blackoutdates", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The blackout dates of the store location.", "default": null, "example": [ "2024-01-01", "2024-01-02" ] }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Taylor" }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person at the store location. If unknown, pass 'Manager'. Limited to 80 characters.", "default": null, "example": "Swift" }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the person at the store location.", "default": null, "example": "taylor@swift.com" }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The pickup instructions of the store location. Limited to 280 characters. Nash Recommended Input: Order [insert order number] for [insert customer name] from [business name]", "default": null, "example": "Once you arrive at the store, please click above to let us know you are here. Then, go ahead and find a sales associate inside - they'll be happy to help you!" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Store business name at the origin. Limited to 80 characters.", "default": null }, "phoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the store location: '+15555555555'", "default": null }, "address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the store location for this package within the Job. Address format: [Number] [Street], [second line], [city], [state] [zip code]. All address fields are required except 'second line'. Second line should include Apt/Suite/Unit/# appended to the number of the unit.", "default": null }, "addressComponents": { "anyOf": [ { "$ref": "#/components/schemas/ParsedAddressInputSerializer" }, { "type": "null" } ], "description": "A geocoded and componentized version of the pickup address. NOTE: THIS WILL BYPASS OUR ADDRESS GEOCODING SERVICE!", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Free form tags specific to the location.", "default": null, "example": "['service:rapid', 'service:express', 'franchise_location']" }, "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The zone ids to associate with the store location.", "default": null, "example": [ "zone_01234567890123456789", "zone_01234567890123456789" ] }, "zoneAssociations": { "title": "Zoneassociations", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "The zone associations to associate with the store location.", "default": null, "example": [ { "end_date": "2025-01-01", "start_date": "2024-01-01", "zone_id": "zone_01234567890123456789" } ] } }, "description": "Expected input payload for updating a store location." }, "UpdateWorkflowInputSerializer": { "title": "UpdateWorkflowInputSerializer", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "status": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowStatus" }, { "type": "null" } ], "default": null }, "nodes": { "title": "Nodes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNodeInputSerializer" } }, { "type": "null" } ], "default": null }, "edges": { "title": "Edges", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEdgeInputSerializer" } }, { "type": "null" } ], "default": null }, "trigger": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowTriggerInputSerializer" }, { "type": "null" } ], "default": null } } }, "UpdateZoneInputSerializer": { "title": "UpdateZoneInputSerializer", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the zone.", "default": null, "example": "Zone 1" }, "coverageAreaId": { "title": "Coverageareaid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The coverage area id to associate with the zone.", "default": null }, "polygon": { "title": "Polygon", "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, { "type": "null" } ], "description": "The zone boundary, as a single closed ring of [latitude, longitude] coordinate pairs. The first and last point must be identical to close the ring. Setting this replaces the polygon on the zone's coverage area (creating a coverage area if the zone has none).", "default": null, "example": [ [ 37.7749, -122.4194 ], [ 37.8049, -122.4194 ], [ 37.8049, -122.3894 ], [ 37.7749, -122.3894 ], [ 37.7749, -122.4194 ] ] }, "storeLocationIds": { "title": "Storelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The store location ids to associate with the zone.", "default": null }, "storeLocationAssociations": { "title": "Storelocationassociations", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "The store location associations to associate with the zone.", "default": null, "example": [ { "end_date": "2025-01-01", "start_date": "2024-01-01", "store_location_id": "stl_01234567890123456789" } ] }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Free form tags specific to the location.", "default": null, "example": "['service:rapid', 'service:express', 'franchise_location']" }, "zoneMetadata": { "title": "Zonemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the zone.", "default": null, "example": { "key": "value" } } }, "description": "Expected input payload for updating a zone." }, "UpsertOrderBulkPayload": { "title": "UpsertOrderBulkPayload", "required": [ "action", "data" ], "type": "object", "properties": { "action": { "title": "Action", "type": "string", "const": "upsert" }, "data": { "$ref": "#/components/schemas/UpsertOrderInput" } } }, "UpsertOrderErrorExample": { "title": "UpsertOrderErrorExample", "required": [ "errorCode", "message" ], "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External id of the order that failed to upsert.", "default": null, "example": "1234567890" }, "errorCode": { "title": "Errorcode", "type": "string", "description": "Machine-readable error code for the failure.", "example": "ORDER_ALREADY_DISPATCHED" }, "message": { "title": "Message", "type": "string", "description": "Human-readable error message.", "example": "Order has already been dispatched to job_1234567890" } }, "description": "Error entry returned by `POST /v1/orders/external-identifier` when a single order fails.\n\nDistinguished from a successful order entry by the presence of `errorCode` (and the absence\nof `id`)." }, "UpsertOrderInput": { "title": "UpsertOrderInput", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order unique identifier from an external system.", "default": null }, "pickupAddress": { "title": "Pickupaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the pickup location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "pickupPlaceId": { "title": "Pickupplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the pickup location.", "default": null }, "pickupPhoneNumber": { "title": "Pickupphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the pickup location in the form: '+15555555555'", "default": null }, "pickupBusinessName": { "title": "Pickupbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup business name at the origin. Limited to 80 characters.", "default": null }, "pickupFirstName": { "title": "Pickupfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupLastName": { "title": "Pickuplastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the person to pickup from. If unknown pass 'Manager'. Limited to 80 characters.", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for pickup. Limited to 280 characters.", "default": null }, "pickupStoreLocationId": { "title": "Pickupstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique identifier for store location created in Nash.", "default": null }, "pickupExternalStoreLocationId": { "title": "Pickupexternalstorelocationid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external identifier used for your store.", "default": null }, "pickupStoreLocationIds": { "title": "Pickupstorelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of store location IDs (internal or external) to consider for the Order. The optimal store will be selected and returned in the response in `pickupStoreLocationId` and/or `pickupStoreLocationExternalId`.", "default": null }, "pickupZoneIds": { "title": "Pickupzoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of zone IDs to consider for the Order. The pickup store location will be selected later via selected delivery window.", "default": null }, "pickupBarcodes": { "title": "Pickupbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values that are required to be scanned at the pickup waypoint.", "default": null }, "pickupEmail": { "title": "Pickupemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the pickup location.", "default": null }, "dropoffAddress": { "title": "Dropoffaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The full address in one line for the dropoff location. Format: [Number] [Street], [second line], [city], [state], [zip code].", "default": null }, "dropoffPlaceId": { "title": "Dropoffplaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Google place id for the dropoff location.", "default": null }, "dropoffPhoneNumber": { "title": "Dropoffphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The phone number to contact at the dropoff location in the form: '+15555555555'", "default": null }, "dropoffBusinessName": { "title": "Dropoffbusinessname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the business at the destination. Should be left empty if there is no business. Limited to 80 characters.", "default": null }, "dropoffFirstName": { "title": "Dropofffirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "First name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffLastName": { "title": "Dropofflastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Last name of the contact at the destination. Limited to 80 characters.", "default": null }, "dropoffInstructions": { "title": "Dropoffinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any special instructions for dropoff. Limited to 280 characters.", "default": null }, "dropoffBarcodes": { "title": "Dropoffbarcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Array containing barcode values/types that are required to be scanned at the dropoff waypoint.", "default": null }, "dropoffEmail": { "title": "Dropoffemail", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The email of the contact at the dropoff location.", "default": null }, "deliveryMode": { "title": "Deliverymode", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "'now' or 'scheduled' when the delivery should be scheduled", "default": null }, "pickupStartTime": { "title": "Pickupstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "pickupEndTime": { "title": "Pickupendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest pickup time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffStartTime": { "title": "Dropoffstarttime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The earliest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "dropoffEndTime": { "title": "Dropoffendtime", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The latest dropoff time in UTC in the form 'YYYY-MM-DDTHH:MM:SSZ'", "default": null }, "deliveryWindowId": { "title": "Deliverywindowid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Delivery window id if using Nash delivery windows", "default": null }, "description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Order description and notes. Limited to 280 characters.", "default": null }, "itemsCount": { "title": "Itemscount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of items in this order", "default": null }, "currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local currency", "default": null }, "valueCents": { "title": "Valuecents", "anyOf": [ { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "Order value in cents", "default": null }, "tipAmountCents": { "title": "Tipamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Tip paid to the driver in cents", "default": null }, "dueAmountCents": { "title": "Dueamountcents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Cash the driver must collect from the recipient on delivery, in cents. Set it to valueCents for a cash-on-delivery order and to 0 for a prepaid one; must not exceed valueCents. Omit when not applicable \u2014 providers then treat the order as prepaid. Forwarded to providers that support collect-on-delivery (currently Dash).", "default": null, "example": 10000 }, "requirements": { "title": "Requirements", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PackageRequirements" } }, { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Package requirements.", "default": null, "example": [ "photo_proof_of_delivery", "age_verification_on_delivery" ] }, "minimumVehicleSize": { "title": "Minimumvehiclesize", "enum": [ "any", "bike", "motorbike", "cargobike", "cargo_bike", "sedan", "car", "suv", "pickup_truck", "pickup", "van", "large_van", "extra_large_van", "truck" ], "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The requested minimum vehicle size. Allowed values: ['any', 'bike', 'motorbike', 'cargobike', 'cargo_bike', 'sedan', 'car', 'suv', 'pickup_truck', 'pickup', 'van', 'large_van', 'extra_large_van', 'truck']", "default": null, "example": "car" }, "dispatchStrategyId": { "title": "Dispatchstrategyid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The dispatch strategy id (or option group id) to be associated with the order.\n\n Note: Best practice is to allow automations to control dispatch strategy and not send the dispatch strategy id in the request.", "default": null }, "orderMetadata": { "title": "Ordermetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Key-value data to attach to this order.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Optional order tags, they will be included in every response", "default": null }, "referenceId": { "title": "Referenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A non-unique identifier for orders, visible to the courier if supported by the provider.", "default": null }, "pickupAddressNumber": { "title": "Pickupaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "pickupAddressSecondarynumber": { "title": "Pickupaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "pickupAddressFormattedStreet": { "title": "Pickupaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "pickupAddressCity": { "title": "Pickupaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the pickup address.", "default": null }, "pickupAddressCounty": { "title": "Pickupaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the pickup address.", "default": null }, "pickupAddressState": { "title": "Pickupaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the pickup address.", "default": null }, "pickupAddressZip": { "title": "Pickupaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the pickup address.", "default": null }, "pickupAddressCountry": { "title": "Pickupaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the pickup address.", "default": null }, "pickupLat": { "title": "Pickuplat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup latitude coordinate.", "default": null }, "pickupLng": { "title": "Pickuplng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The pickup longitude coordinate.", "default": null }, "dropoffAddressNumber": { "title": "Dropoffaddressnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The number on a house.", "default": null }, "dropoffAddressSecondarynumber": { "title": "Dropoffaddresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number on an address e.g. an apartment building.", "default": null }, "dropoffAddressFormattedStreet": { "title": "Dropoffaddressformattedstreet", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The street of the address.", "default": null }, "dropoffAddressCity": { "title": "Dropoffaddresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The city of the dropoff address.", "default": null }, "dropoffAddressCounty": { "title": "Dropoffaddresscounty", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The county associated with the dropoff address.", "default": null }, "dropoffAddressState": { "title": "Dropoffaddressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The state of the dropoff address.", "default": null }, "dropoffAddressZip": { "title": "Dropoffaddresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The zip or postal code of the dropoff address.", "default": null }, "dropoffAddressCountry": { "title": "Dropoffaddresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ISO 3166-1 alpha-2 country code of the dropoff address.", "default": null }, "dropoffLat": { "title": "Dropofflat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff latitude coordinate.", "default": null }, "dropoffLng": { "title": "Dropofflng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The dropoff longitude coordinate.", "default": null }, "weight": { "title": "Weight", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ], "description": "The total weight of the package in kilograms (kg)", "default": null }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for weight: 'kg' or 'lbs'. Defaults to 'kg'. Weight is always stored in kg; a weight provided in 'lbs' is converted on ingest.", "default": null }, "height": { "title": "Height", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total height of the package in centimeters (cm)", "default": null }, "width": { "title": "Width", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total width of the package in centimeters (cm)", "default": null }, "depth": { "title": "Depth", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total depth of the package in centimeters (cm)", "default": null }, "volume": { "title": "Volume", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "The total volume of the package in cubic centimeters (cm^3)", "default": null }, "lengthUnit": { "title": "Lengthunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Unit for height/width/depth and volume: 'cm' or 'in'. Defaults to 'cm'. Dimensions are always stored in cm (cm^3 for volume); values provided in 'in' (cubic inches for volume) are converted on ingest.", "default": null }, "items": { "title": "Items", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ItemInput" } }, { "type": "null" } ], "description": "Lists of items in the delivery", "default": null }, "optimizationParameters": { "anyOf": [ { "$ref": "#/components/schemas/OptimizationParameters" }, { "type": "null" } ], "description": "Order-level optimization parameters", "default": null }, "pickupPayment": { "anyOf": [ { "$ref": "#/components/schemas/PickupPayment" }, { "type": "null" } ], "description": "How the courier should pay for the order at pickup (e.g. a barcode or provider card).", "default": null }, "reapplyAutomations": { "title": "Reapplyautomations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "If set to true, the order will be re-evaluated with automations.", "default": null }, "maxDeliveryFeeCents": { "title": "Maxdeliveryfeecents", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The maximum delivery fee for the order in cents. This will override the dispatch strategy max delivery fee if both are set.", "default": null }, "id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The ID of the order", "default": null } } }, "UpsertOrdersByExternalIdOutputExample": { "title": "UpsertOrdersByExternalIdOutputExample", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/OrderOutputExample" }, { "$ref": "#/components/schemas/UpsertOrderErrorExample" } ] }, "description": "Response of `POST /v1/orders/external-identifier`: one entry per input order, same index.\n\nEach entry is either the upserted order (`OrderOutputExample`, carries `id`) or an\n`UpsertOrderErrorExample` (carries `errorCode`) when that single order failed. A failure on\none order does not fail the batch." }, "UpsertRouteInputSerializer": { "title": "UpsertRouteInputSerializer", "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Route ID. If provided, the route will be updated. If not provided, a new route will be created.", "default": null, "example": "rte_JphRWDiEosGpXuxwgaYfY3" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the route.", "default": null, "example": "Route 1" }, "stops": { "title": "Stops", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/RouteStopInputSerializer" } }, { "type": "null" } ], "description": "Complete route stops structure with timing, location, and stop types. Supports all stop types including PICKUP, DROPOFF, ROUTE_START, ROUTE_END, and DRIVER_BREAK.", "default": null, "example": [ { "arrival_time": "2025-04-25T08:00:00Z", "depart_time": "2025-04-25T08:00:00Z", "location": { "lat": 40.7128, "lng": -74.006 }, "object_ids": [ "stl_warehouse_123" ], "service_time": 0, "stop_type": "ROUTE_START" }, { "distance_from_previous": 5000, "duration_from_previous": 1200, "location": { "lat": 40.7589, "lng": -73.9851 }, "object_ids": [ "ord_123", "ord_456" ], "service_time": 600, "stop_type": "PICKUP" }, { "arrival_time": "2025-04-25T10:00:00Z", "depart_time": "2025-04-25T10:30:00Z", "object_ids": [ "break_001" ], "service_time": 1800, "stop_type": "DRIVER_BREAK" }, { "distance_from_previous": 2000, "duration_from_previous": 600, "location": { "lat": 40.7505, "lng": -73.9934 }, "object_ids": [ "ord_123" ], "service_time": 180, "stop_type": "DROPOFF" } ] }, "routeMetadata": { "title": "Routemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Additional metadata for the route.", "default": null, "example": { "priority": "high", "source": "optimization_engine" } }, "vehicleId": { "title": "Vehicleid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Vehicle ID (or external ID) to assign to this route.", "default": null, "example": "veh_4hL8pXq2sVn6RtY3wCbD9M" }, "courierId": { "title": "Courierid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Courier/Driver ID (or external ID) to assign to this route.", "default": null, "example": "cor_9dK2mNp7xVt3RfWzY8sLbQ" }, "driverGroupId": { "title": "Drivergroupid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Driver group/Contract ID (or external ID) to assign to this route. Required when assigning a courier or vehicle.", "default": null, "example": "cntr_7mP3xVt9Nk8sRfWzY2hLbQ" }, "autoDispatch": { "title": "Autodispatch", "type": "boolean", "description": "If true, dispatch the route to providers in the same request after upsert. Default: false.", "default": false } }, "description": "Input for creating or updating a route." }, "UpsertRouteResponseSerializer": { "title": "UpsertRouteResponseSerializer", "required": [ "route" ], "type": "object", "properties": { "route": { "$ref": "#/components/schemas/RouteSerializer", "description": "The created or updated route." } }, "description": "Response for route upsert operation." }, "UpsertShiftsByExternalIdRequest": { "title": "UpsertShiftsByExternalIdRequest", "required": [ "shifts" ], "type": "object", "properties": { "shifts": { "title": "Shifts", "maxItems": 500, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ShiftUpsertInput" } } }, "additionalProperties": false }, "UpsertShiftsByExternalIdResponse": { "title": "UpsertShiftsByExternalIdResponse", "required": [ "results" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/ShiftUpsertReceipt" } } } }, "UpsertZoneInputSerializer": { "title": "UpsertZoneInputSerializer", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the zone.", "default": null, "example": "Zone 1" }, "coverageAreaId": { "title": "Coverageareaid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The coverage area id to associate with the zone.", "default": null }, "polygon": { "title": "Polygon", "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, { "type": "null" } ], "description": "The zone boundary, as a single closed ring of [latitude, longitude] coordinate pairs. The first and last point must be identical to close the ring. Setting this replaces the polygon on the zone's coverage area (creating a coverage area if the zone has none).", "default": null, "example": [ [ 37.7749, -122.4194 ], [ 37.8049, -122.4194 ], [ 37.8049, -122.3894 ], [ 37.7749, -122.3894 ], [ 37.7749, -122.4194 ] ] }, "storeLocationIds": { "title": "Storelocationids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The store location ids to associate with the zone.", "default": null }, "storeLocationAssociations": { "title": "Storelocationassociations", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "The store location associations to associate with the zone.", "default": null, "example": [ { "end_date": "2025-01-01", "start_date": "2024-01-01", "store_location_id": "stl_01234567890123456789" } ] }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Free form tags specific to the location.", "default": null, "example": "['service:rapid', 'service:express', 'franchise_location']" }, "zoneMetadata": { "title": "Zonemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the zone.", "default": null, "example": { "key": "value" } }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the zone.", "default": null, "example": "zone_01234567890123456789" }, "cityZipcodes": { "title": "Cityzipcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The city-zipcode pairs to associate with the zone.", "default": null, "example": [ "Melbourne_3000", "Sydney_2000" ] } }, "description": "Expected input payload for upserting a zone by external id." }, "UpsertZoneRestrictionInputSerializer": { "title": "UpsertZoneRestrictionInputSerializer", "required": [ "name" ], "type": "object", "properties": { "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external id of the zone restriction.", "default": null, "example": "zone_01234567890123456789" }, "name": { "title": "Name", "type": "string", "description": "The name of the zone restriction." }, "isActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the zone restriction is active.", "default": null }, "restrictionMetadata": { "title": "Restrictionmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the zone restriction.", "default": null, "example": { "key": "value" } } }, "description": "Expected input payload for upserting a zone restriction by external id." }, "UpsertZoneRestrictionsInputSerializer": { "title": "UpsertZoneRestrictionsInputSerializer", "required": [ "zoneRestrictions" ], "type": "object", "properties": { "zoneRestrictions": { "title": "Zonerestrictions", "type": "array", "items": { "$ref": "#/components/schemas/UpsertZoneRestrictionInputSerializer" } } }, "description": "Expected input payload for upserting multiple zone restrictions." }, "UpsertZonesInputSerializer": { "title": "UpsertZonesInputSerializer", "required": [ "zones" ], "type": "object", "properties": { "zones": { "title": "Zones", "type": "array", "items": { "$ref": "#/components/schemas/UpsertZoneInputSerializer" } } }, "description": "Expected input payload for upserting multiple zones." }, "UserCreate": { "title": "UserCreate", "required": [ "email" ], "type": "object", "properties": { "email": { "title": "Email", "type": "string", "format": "email" }, "roleIds": { "title": "Roleids", "type": "array", "items": { "type": "string" }, "default": [] }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "phoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "auth0Id": { "title": "Auth0Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "isNashSuperuser": { "title": "Isnashsuperuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "isNashOperations": { "title": "Isnashoperations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null } } }, "UserInvite": { "title": "UserInvite", "required": [ "email", "roleIds" ], "type": "object", "properties": { "email": { "title": "Email", "type": "string", "format": "email" }, "roleIds": { "title": "Roleids", "type": "array", "items": { "type": "string" } } } }, "UserRead": { "title": "UserRead", "required": [ "id", "isActive" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "auth0Id": { "title": "Auth0Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "isActive": { "title": "Isactive", "type": "boolean" }, "isNashSuperuser": { "title": "Isnashsuperuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "isNashOperations": { "title": "Isnashoperations", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "roles": { "title": "Roles", "type": "array", "items": { "$ref": "#/components/schemas/RoleRead" }, "default": [] } } }, "UsersListResponse": { "title": "UsersListResponse", "required": [ "users" ], "type": "object", "properties": { "users": { "title": "Users", "type": "array", "items": { "$ref": "#/components/schemas/UserRead" } } } }, "VehicleConfig": { "title": "VehicleConfig", "type": "object", "properties": { "weight": { "title": "Weight", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The weight of the vehicle.", "default": null }, "height": { "title": "Height", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The height of the vehicle.", "default": null }, "length": { "title": "Length", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The length of the vehicle.", "default": null }, "width": { "title": "Width", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The width of the vehicle.", "default": null }, "axlecount": { "title": "Axlecount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of axles on the vehicle.", "default": null }, "trailercount": { "title": "Trailercount", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The number of trailers on the vehicle.", "default": null }, "weightunit": { "title": "Weightunit", "anyOf": [ { "enum": [ "kg", "lbs" ], "type": "string" }, { "type": "null" } ], "description": "Unit for weight: 'kg' or 'lbs'. Defaults to 'kg'.", "default": null }, "lengthunit": { "title": "Lengthunit", "anyOf": [ { "enum": [ "meter", "in" ], "type": "string" }, { "type": "null" } ], "description": "Unit for length, width, and height: 'meter' or 'in'. Defaults to 'meter'.", "default": null }, "maxstops": { "title": "Maxstops", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The max stops of the vehicle.", "default": null }, "maxdistance": { "title": "Maxdistance", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The max distance of the vehicle.", "default": null }, "maxduration": { "title": "Maxduration", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "The max duration of the vehicle.", "default": null }, "speedfactor": { "title": "Speedfactor", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The speed factor of the vehicle.", "default": null }, "capabilities": { "title": "Capabilities", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The capabilities of the vehicle.", "default": null }, "fixedcost": { "title": "Fixedcost", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Fixed cost to assign this vehicle with tasks.", "default": null }, "costperunitdistance": { "title": "Costperunitdistance", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Cost per unit distance for this vehicle.", "default": null }, "costperunittime": { "title": "Costperunittime", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Cost per unit time for this vehicle.", "default": null }, "vehicleprofile": { "title": "Vehicleprofile", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The vehicle profile type (car, truck, bicycle, flying_distance).", "default": null }, "minordersperroute": { "title": "Minordersperroute", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Minimum number of orders per route.", "default": null }, "parkingtime": { "title": "Parkingtime", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Parking time at order locations (in hours).", "default": null } }, "description": "Response for vehicle config." }, "VehicleDisplaySize": { "title": "VehicleDisplaySize", "enum": [ "bike", "motorbike", "cargobike", "car", "suv", "pickup_truck", "van", "truck", "large_van", "extra_large_van" ], "type": "string" }, "VehicleFieldChange": { "title": "VehicleFieldChange", "required": [ "path", "direction" ], "type": "object", "properties": { "path": { "title": "Path", "type": "string" }, "before": { "$ref": "#/components/schemas/JsonValue", "default": null }, "after": { "$ref": "#/components/schemas/JsonValue", "default": null }, "direction": { "$ref": "#/components/schemas/ChangeDirection" } } }, "VehicleInfo": { "title": "VehicleInfo", "type": "object", "properties": { "type": { "anyOf": [ { "$ref": "#/components/schemas/VehicleDisplaySize" }, { "type": "null" } ], "description": "The type of the vehicle.", "default": null }, "make": { "title": "Make", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The make of the vehicle.", "default": null }, "model": { "title": "Model", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model of the vehicle.", "default": null }, "licenseplate": { "title": "Licenseplate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The license plate of the vehicle.", "default": null }, "color": { "title": "Color", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The color of the vehicle.", "default": null }, "year": { "title": "Year", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The year of the vehicle.", "default": null } }, "description": "Response for vehicle info." }, "VehicleLocation": { "title": "VehicleLocation", "required": [ "lat", "lng" ], "type": "object", "properties": { "lat": { "title": "Lat", "type": "number", "description": "The latitude of the vehicle location." }, "lng": { "title": "Lng", "type": "number", "description": "The longitude of the vehicle location." } }, "description": "Response for vehicle location." }, "VehicleResponse": { "title": "VehicleResponse", "required": [ "id", "name", "providerid", "externalidentifier", "enabled", "vehicleinfo", "vehicleconfig", "courierids" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the vehicle." }, "name": { "title": "Name", "type": "string", "description": "The name of the vehicle." }, "providerid": { "title": "Providerid", "type": "string", "description": "The provider ID of the vehicle." }, "externalidentifier": { "title": "Externalidentifier", "type": "string", "description": "The external identifier of the vehicle." }, "enabled": { "title": "Enabled", "type": "boolean", "description": "Whether the vehicle is enabled." }, "vehicleinfo": { "$ref": "#/components/schemas/VehicleInfo", "description": "The vehicle info of the vehicle." }, "vehicleconfig": { "$ref": "#/components/schemas/VehicleConfig", "description": "The vehicle config of the vehicle." }, "courierids": { "title": "Courierids", "type": "array", "items": { "type": "string" }, "description": "The couriers of the vehicle." } }, "description": "Response for vehicle." }, "VehicleSerializer": { "title": "VehicleSerializer", "type": "object", "properties": { "licensePlate": { "title": "Licenseplate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "make": { "title": "Make", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "model": { "title": "Model", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "color": { "title": "Color", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "year": { "title": "Year", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null } }, "description": "Vehicle details for a route." }, "VehicleTypeChange": { "title": "VehicleTypeChange", "required": [ "vehicle_type_id", "changes" ], "type": "object", "properties": { "vehicle_type_id": { "title": "Vehicle Type Id", "type": "string" }, "changes": { "title": "Changes", "type": "array", "items": { "$ref": "#/components/schemas/VehicleFieldChange" } } } }, "VehiclesDiff": { "title": "VehiclesDiff", "required": [ "previous_vans", "current_vans", "previous_order_slots", "current_order_slots", "previous_retained_order_slots", "current_retained_order_slots", "added_type_ids", "removed_type_ids", "changed" ], "type": "object", "properties": { "previous_vans": { "title": "Previous Vans", "type": "integer" }, "current_vans": { "title": "Current Vans", "type": "integer" }, "previous_order_slots": { "title": "Previous Order Slots", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "current_order_slots": { "title": "Current Order Slots", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "previous_retained_order_slots": { "title": "Previous Retained Order Slots", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "current_retained_order_slots": { "title": "Current Retained Order Slots", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "added_type_ids": { "title": "Added Type Ids", "type": "array", "items": { "type": "string" } }, "removed_type_ids": { "title": "Removed Type Ids", "type": "array", "items": { "type": "string" } }, "changed": { "title": "Changed", "type": "array", "items": { "$ref": "#/components/schemas/VehicleTypeChange" } } } }, "VerifyPhotoInputSerializer": { "title": "VerifyPhotoInputSerializer", "required": [ "jobId", "photoType" ], "type": "object", "properties": { "jobId": { "title": "Jobid", "type": "string", "description": "The job to verify a photo for." }, "photoType": { "$ref": "#/components/schemas/PhotoType", "description": "Which photo to verify." }, "userQuestion": { "title": "Userquestion", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional extra guidance for the LLM (e.g. 'Is the package on the doorstep?').", "default": null }, "imageUrl": { "title": "Imageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Verify this photo instead of the latest photo of photo_type. It must be one of the job's own proof-of-delivery photos (any type, any delivery attempt) on Nash's photo bucket; photo_type still picks the verifier.", "default": null } } }, "WebhookEventTypesResponse": { "title": "WebhookEventTypesResponse", "required": [ "eventTypes", "source" ], "type": "object", "properties": { "eventTypes": { "title": "Eventtypes", "type": "array", "items": { "type": "string" }, "description": "Sorted list of Svix event type names (e.g. `delivery.dropoff_complete`)." }, "source": { "title": "Source", "enum": [ "org_active", "catalog" ], "type": "string", "description": "`org_active` when filtered to types this org's endpoints subscribe to; `catalog` when at least one endpoint subscribes to all events, in which case the full Svix event-type catalog is returned." } } }, "WebhookMessage": { "title": "WebhookMessage", "required": [ "id", "eventType", "timestamp" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "eventId": { "title": "Eventid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "eventType": { "title": "Eventtype", "type": "string" }, "timestamp": { "title": "Timestamp", "type": "string", "format": "date-time" }, "channels": { "title": "Channels", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null }, "payload": { "title": "Payload", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "default": null } } }, "WebhookMessageAttempt": { "title": "WebhookMessageAttempt", "required": [ "id", "msgId", "endpointId", "url", "status", "timestamp" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "msgId": { "title": "Msgid", "type": "string" }, "endpointId": { "title": "Endpointid", "type": "string" }, "url": { "title": "Url", "type": "string" }, "status": { "title": "Status", "type": "string", "description": "One of: success, pending, fail, sending" }, "responseStatusCode": { "title": "Responsestatuscode", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "responseDurationMs": { "title": "Responsedurationms", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null }, "response": { "title": "Response", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "triggerType": { "title": "Triggertype", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "timestamp": { "title": "Timestamp", "type": "string", "format": "date-time" } } }, "WebhookMessageAttemptsResponse": { "title": "WebhookMessageAttemptsResponse", "required": [ "results", "done" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/WebhookMessageAttempt" } }, "iterator": { "title": "Iterator", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "prevIterator": { "title": "Previterator", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "done": { "title": "Done", "type": "boolean" } } }, "WebhookMessageReplayRequest": { "title": "WebhookMessageReplayRequest", "type": "object", "properties": { "msgId": { "title": "Msgid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Replay this specific Svix message. Mutually exclusive with `tag` + `eventType` lookup.", "default": null, "example": "msg_01HXABC" }, "tag": { "title": "Tag", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Find a message by tag (Nash entity ID like `dlv_123`) and replay it. Must be paired with `eventType`. The most recent matching message is replayed.", "default": null, "example": "dlv_123" }, "eventType": { "title": "Eventtype", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Svix event type to filter on when looking up by `tag` (e.g. `delivery.dropoff_complete`). Required when `tag` is provided so we don't replay an unrelated event for the same entity.", "default": null, "example": "delivery.dropoff_complete" }, "endpointId": { "title": "Endpointid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Replay only to this endpoint. If omitted, replays to every endpoint the message was originally attempted against.", "default": null, "example": "ep_01HX" }, "idempotencyKey": { "title": "Idempotencykey", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional Svix idempotency key forwarded on each per-endpoint resend call.", "default": null } } }, "WebhookMessageReplayResponse": { "title": "WebhookMessageReplayResponse", "required": [ "msgId", "total", "succeeded", "failed", "results" ], "type": "object", "properties": { "msgId": { "title": "Msgid", "type": "string", "description": "Svix message ID that was replayed (resolved from filters when applicable)." }, "eventType": { "title": "Eventtype", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Event type of the replayed message \u2014 confirmation that we picked the right event when looking up by `tag` + `eventType`. Null when caller replayed by `msgId` (no extra lookup performed).", "default": null }, "total": { "title": "Total", "type": "integer", "description": "Number of endpoints the replay was dispatched to." }, "succeeded": { "title": "Succeeded", "type": "integer" }, "failed": { "title": "Failed", "type": "integer" }, "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/WebhookMessageReplayResult" } } } }, "WebhookMessageReplayResult": { "title": "WebhookMessageReplayResult", "required": [ "endpointId", "success" ], "type": "object", "properties": { "endpointId": { "title": "Endpointid", "type": "string" }, "url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "success": { "title": "Success", "type": "boolean" }, "error": { "title": "Error", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Set when Svix rejected the resend (e.g. endpoint disabled, payload expunged).", "default": null } } }, "WebhookMessagesListResponse": { "title": "WebhookMessagesListResponse", "required": [ "results", "done" ], "type": "object", "properties": { "results": { "title": "Results", "type": "array", "items": { "$ref": "#/components/schemas/WebhookMessage" } }, "iterator": { "title": "Iterator", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor to pass back in the next request to fetch older messages. Null when `done` is true.", "default": null }, "prevIterator": { "title": "Previterator", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "done": { "title": "Done", "type": "boolean" } } }, "WeightedItemInfoInputSerializer": { "title": "WeightedItemInfoInputSerializer", "type": "object", "properties": { "weightPerItem": { "title": "Weightperitem", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight per individual item", "default": null, "example": 0.5 }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The unit of weight measurement", "default": null, "example": "kg" } } }, "WeightedItemInfoOutputSerializer": { "title": "WeightedItemInfoOutputSerializer", "type": "object", "properties": { "weightPerItem": { "title": "Weightperitem", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The weight per individual item", "default": null, "example": 0.5 }, "weightUnit": { "title": "Weightunit", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The unit of weight measurement", "default": null, "example": "kg" } } }, "WidgetEmbedCredentialIssued": { "title": "WidgetEmbedCredentialIssued", "required": [ "credential", "secret" ], "type": "object", "properties": { "credential": { "$ref": "#/components/schemas/WidgetEmbedCredentialRead" }, "secret": { "title": "Secret", "type": "string", "description": "Plaintext credential. Shown once, never retrievable again." } }, "description": "The one and only response shape that carries a plaintext secret.\n\nCallers must surface `secret` to the operator immediately; it cannot be\nrecovered afterwards because only its hash is stored." }, "WidgetEmbedCredentialRead": { "title": "WidgetEmbedCredentialRead", "required": [ "id", "organization_id", "name", "last_four", "created_at", "status" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "organization_id": { "title": "Organization Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "last_four": { "title": "Last Four", "type": "string" }, "expires_at": { "title": "Expires At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "revoked_at": { "title": "Revoked At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "last_used_at": { "title": "Last Used At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "created_by_user_id": { "title": "Created By User Id", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" }, "updated_at": { "title": "Updated At", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "default": null }, "status": { "$ref": "#/components/schemas/WidgetEmbedCredentialStatus", "description": "Display status for the Portal admin list.\n\nThis is a *presentation* read, not the authorization decision \u2014 the\nauthoritative \"is this credential usable\" filter runs in SQL inside\n`WidgetEmbedCredentialRepository`, against the database clock, so the\ntwo can never disagree because of a drifting app-server clock.\n`set_to_utc` makes the comparison total even if a caller hands in a\nnaive value.", "readOnly": true } } }, "WidgetEmbedCredentialRotation": { "title": "WidgetEmbedCredentialRotation", "required": [ "issued", "retired" ], "type": "object", "properties": { "issued": { "$ref": "#/components/schemas/WidgetEmbedCredentialIssued" }, "retired": { "$ref": "#/components/schemas/WidgetEmbedCredentialRead" } }, "description": "Result of a rotation: the new credential, plus the outgoing one.\n\n`retired` reflects the outgoing credential *after* the rotation was applied\n\u2014 either revoked outright, or given an expiry that ends the overlap window." }, "WidgetEmbedCredentialStatus": { "title": "WidgetEmbedCredentialStatus", "enum": [ "active", "expired", "revoked" ], "type": "string" }, "WidgetEmbedCredentialsResponse": { "title": "WidgetEmbedCredentialsResponse", "required": [ "embed_credentials" ], "type": "object", "properties": { "embed_credentials": { "title": "Embed Credentials", "type": "array", "items": { "$ref": "#/components/schemas/WidgetEmbedCredentialRead" } } } }, "WidgetEnablement": { "title": "WidgetEnablement", "required": [ "widget" ], "type": "object", "properties": { "widget": { "$ref": "#/components/schemas/WidgetKind" }, "enabled": { "title": "Enabled", "type": "boolean", "default": false } }, "additionalProperties": false, "description": "Whether one widget is turned on for the org, as the merchant set it." }, "WidgetEntitlement": { "title": "WidgetEntitlement", "required": [ "widget", "enabled", "kill_switch_active", "available" ], "type": "object", "properties": { "widget": { "$ref": "#/components/schemas/WidgetKind" }, "enabled": { "title": "Enabled", "type": "boolean" }, "kill_switch_active": { "title": "Kill Switch Active", "type": "boolean" }, "allowed_origins": { "title": "Allowed Origins", "type": "array", "items": { "type": "string" } }, "available": { "title": "Available", "type": "boolean", "description": "Kill switch wins. A merchant cannot re-enable a killed widget.", "readOnly": true } }, "description": "The resolved answer to \"may this org use this widget right now?\".\n\nThe single object PLAT-22255 (Embed Sessions) and the Live Map data plane\nconsume. It fuses the two sources deliberately kept apart at rest \u2014\nmerchant enablement from Org Preferences, kill switch from the flag SDK \u2014\nso no caller has to remember that there are two, or get their precedence\nbackwards." }, "WidgetKind": { "title": "WidgetKind", "enum": [ "nash_agent", "live_map", "eta_chip", "delivery_list", "delivery_details" ], "type": "string", "description": "The widgets the platform can mint an Embed Session for.\n\nValues are the stable wire identifiers: they key the storage map, name the\nkill-switch flags, and are what a host backend sends as `widget` when\nminting. Adding a member is additive; renaming one is a breaking change to\nstored org config and must be migrated." }, "WidgetSettingsResponse": { "title": "WidgetSettingsResponse", "required": [ "allowed_origins", "widgets" ], "type": "object", "properties": { "allowed_origins": { "title": "Allowed Origins", "type": "array", "items": { "type": "string" } }, "widgets": { "title": "Widgets", "type": "array", "items": { "$ref": "#/components/schemas/WidgetEnablement" } } } }, "WidgetSettingsWrite": { "title": "WidgetSettingsWrite", "type": "object", "properties": { "allowed_origins": { "title": "Allowed Origins", "maxItems": 50, "type": "array", "items": { "type": "string" }, "description": "Exact parent origins (scheme + host + port, no trailing slash, no wildcards)." }, "widgets": { "title": "Widgets", "type": "array", "items": { "$ref": "#/components/schemas/WidgetEnablement" } } }, "additionalProperties": false, "description": "Request body for a settings write.\n\nDeliberately `extra=\"forbid\"`, unlike the stored `WidgetSettings` model\n(which allows extras so it can round-trip keys written by the legacy\n`updateOrganizationPreferences` path). A REST client sending an unknown key\nis making a mistake, and silently persisting it into an authorization-\nbearing blob is the wrong way to find out." }, "WorkRelationship": { "title": "WorkRelationship", "enum": [ "EMPLOYEE", "CONTRACTOR" ], "type": "string" }, "WorkflowEdgeInputSerializer": { "title": "WorkflowEdgeInputSerializer", "required": [ "edgeKey", "sourceNodeKey", "targetNodeKey", "executionOrder" ], "type": "object", "properties": { "edgeKey": { "title": "Edgekey", "type": "string", "description": "Unique key within this workflow." }, "sourceNodeKey": { "title": "Sourcenodekey", "type": "string", "description": "node_key of the source node." }, "targetNodeKey": { "title": "Targetnodekey", "type": "string", "description": "node_key of the target node." }, "executionOrder": { "title": "Executionorder", "type": "integer", "description": "Execution order when a node has multiple outgoing edges." }, "edgeType": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowEdgeType" }, { "type": "null" } ], "description": "Use 'default' for trigger and ordinary action nodes; 'decision' with branchKey for AI Decision. Filters use 'success' or 'negative'.", "default": null }, "branchKey": { "title": "Branchkey", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Required only for decision edges from ai_decision: yes/no for yes_no, a configured choices[].key for choice, above/below for score, or uncertain/error for any mode. At most one edge per outcome per node.", "default": null } } }, "WorkflowEdgeType": { "title": "WorkflowEdgeType", "enum": [ "default", "success", "negative", "decision" ], "type": "string" }, "WorkflowNodeAction": { "title": "WorkflowNodeAction", "enum": [ "dispatch_strategy", "optimization_strategy", "modify_order_price_or_tip", "modify_order_instructions", "modify_order_metadata", "reschedule_order", "add_tag", "flag_delivery", "send_email", "send_sms", "send_slack", "send_webhook", "send_to_destinations", "agent_call", "summarize", "extract_metadata_field", "add_requirements", "auto_reassign", "emit_custom_event", "browser_automation", "cancel_delivery", "mark_order_ready", "send_teams_channel_message", "cancel_order", "remove_order_from_route", "invoke_agent", "ai_decision", "create_route_flag", "update_route_flag", "resolve_route_flag", "assign_route_flags", "send_http_request", "add_validation_error", "generate_document" ], "type": "string", "description": "Actions that can be performed by a workflow node." }, "WorkflowNodeInputSerializer": { "title": "WorkflowNodeInputSerializer", "required": [ "nodeType", "nodeKey", "nodeLabel" ], "type": "object", "properties": { "nodeType": { "$ref": "#/components/schemas/WorkflowNodeType", "description": "Node role: trigger, action, filter, or switch." }, "nodeKey": { "title": "Nodekey", "type": "string", "description": "Unique key within this workflow. Edges reference nodes by this key." }, "nodeAction": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowNodeAction" }, { "type": "null" } ], "description": "Required for action nodes. GET /workflows/schema lists valid actions and their config schemas.", "default": null }, "nodeActionConfig": { "title": "Nodeactionconfig", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Config for the action. Shape depends on node_action. See GET /workflows/schema.", "default": null }, "nodeFilterConfig": { "title": "Nodefilterconfig", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "Filter conditions. Each dict has field, operator, and value. See GET /workflows/schema for available fields and operators.", "default": null }, "nodeLabel": { "title": "Nodelabel", "type": "string", "description": "Human-readable label for this node." }, "isEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null }, "isTrigger": { "title": "Istrigger", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null } } }, "WorkflowNodeType": { "title": "WorkflowNodeType", "enum": [ "trigger", "action", "filter", "switch", "subgraph", "agent_invoke" ], "type": "string", "description": "Types of workflow nodes." }, "WorkflowStatus": { "title": "WorkflowStatus", "enum": [ "draft", "active", "inactive", "archived", "template" ], "type": "string" }, "WorkflowTriggerInputSerializer": { "title": "WorkflowTriggerInputSerializer", "required": [ "triggerType" ], "type": "object", "properties": { "triggerType": { "$ref": "#/components/schemas/WorkflowTriggerType", "description": "Currently only 'event' is supported via this REST API. Other trigger types (manual, cron, webhook) exist but are not exposed here." }, "eventTriggerType": { "title": "Eventtriggertype", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "For notification-based triggers only. Pass the entry's 'value' from the GET /workflows/schema triggers list, not the trigger key. Leave null for event triggers like order.created.", "default": null }, "eventName": { "title": "Eventname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The event to listen for. For schema entries whose input_field is 'eventName', pass the entry's value here (e.g. 'order.created'). For notification triggers, omit this. Defaults to 'notification_trigger.tripped'.", "default": null }, "customEventDefinitionId": { "title": "Customeventdefinitionid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reference to a pre-defined custom event from the organization's catalog. Mutually exclusive with eventName: the definition's key becomes the trigger's event name. Not valid for cron triggers.", "default": null }, "courierFormDefinitionId": { "title": "Courierformdefinitionid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Reference to a CourierFormDefinition. Required when eventName is 'courier_form.submitted'; not valid for any other trigger type.", "default": null }, "notificationTriggerParameters": { "title": "Notificationtriggerparameters", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Extra config for notification triggers. Not used for event triggers.", "default": null }, "isEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null } } }, "WorkflowTriggerType": { "title": "WorkflowTriggerType", "enum": [ "manual", "webhook", "cron", "event", "subgraph" ], "type": "string", "description": "Types of workflow triggers." }, "ZoneCoverageAreaRead": { "title": "ZoneCoverageAreaRead", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Nash coverage area id." }, "cityZipcodes": { "title": "Cityzipcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "City and zip code pairs covered.", "default": null }, "zipCodes": { "title": "Zipcodes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Zip codes covered.", "default": null }, "cities": { "title": "Cities", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Cities covered.", "default": null }, "states": { "title": "States", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "States or regions covered.", "default": null }, "countries": { "title": "Countries", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Two-letter ISO country codes covered.", "default": null }, "polygons": { "title": "Polygons", "type": "array", "items": { "$ref": "#/components/schemas/ZonePolygonRead" }, "description": "Geometry boundaries attached to this coverage area." } } }, "ZoneDetailRead": { "title": "ZoneDetailRead", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Nash zone id." }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Zone name.", "default": null }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your external id for the zone.", "default": null }, "portalUrl": { "title": "Portalurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Nash portal URL for the zone.", "default": null }, "coverageArea": { "anyOf": [ { "$ref": "#/components/schemas/ZoneCoverageAreaRead" }, { "type": "null" } ], "description": "Geographic area the zone covers.", "default": null }, "storeLocations": { "title": "Storelocations", "type": "array", "items": { "$ref": "#/components/schemas/ZoneStoreLocationRead" }, "description": "Store locations associated with the zone." }, "storeLocationAssociations": { "title": "Storelocationassociations", "type": "array", "items": { "$ref": "#/components/schemas/ZoneStoreLocationAssociationRead" }, "description": "Store-location links with optional active date ranges." }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Free-form tags on the zone.", "default": null }, "zoneMetadata": { "title": "Zonemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Arbitrary key-value metadata stored on the zone.", "default": null }, "isDeleted": { "title": "Isdeleted", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the zone is soft-deleted.", "default": null } }, "description": "Full detail for a single zone. Same shape as `GET /v1/zones/`." }, "ZoneGeolocationParams": { "title": "ZoneGeolocationParams", "type": "object", "properties": { "zoneIds": { "title": "Zoneids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": null } } }, "ZoneLocationRead": { "title": "ZoneLocationRead", "type": "object", "properties": { "address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Single-line formatted address of the store location.", "default": null }, "addressFirstLine": { "title": "Addressfirstline", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Street line of the address.", "default": null }, "addressSecondarynumber": { "title": "Addresssecondarynumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Secondary number (unit, suite) if any.", "default": null }, "addressCity": { "title": "Addresscity", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "City.", "default": null }, "addressCountry": { "title": "Addresscountry", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Two-letter ISO country code.", "default": null }, "addressState": { "title": "Addressstate", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "State or region.", "default": null }, "addressZip": { "title": "Addresszip", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Postal code.", "default": null }, "lat": { "title": "Lat", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Latitude.", "default": null }, "lng": { "title": "Lng", "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Longitude.", "default": null } } }, "ZonePolygonRead": { "title": "ZonePolygonRead", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Nash polygon id." }, "polygonData": { "title": "Polygondata", "anyOf": [ { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, { "type": "null" } ], "description": "Closed ring of [latitude, longitude] coordinate pairs defining the boundary.", "default": null } } }, "ZoneResponse": { "title": "ZoneResponse", "required": [ "id", "name", "externalId", "portalUrl", "coverageArea", "storeLocations", "storeLocationAssociations", "zoneRestrictions", "tags", "zoneMetadata", "isDeleted" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the zone.", "example": "zone_01234567890123456789" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The name of the zone.", "example": "Zone 1" }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The external ID of the zone.", "example": "ext_01234567890123456789" }, "portalUrl": { "title": "Portalurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The portal URL of the zone.", "example": "https://portal.usenash.com/settings/zones/zone_01234567890123456789" }, "coverageArea": { "title": "Coveragearea", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The coverage area of the zone.", "example": { "cities": [ "San Francisco" ], "cityZipcodes": [], "countries": [], "id": "coa_01234567890123456789", "states": [], "zipCodes": [ "94114" ] } }, "storeLocations": { "title": "Storelocations", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/StoreLocationResponse" } }, { "type": "null" } ], "description": "The store locations of the zone.", "example": [ { "blackoutDates": [], "email": "", "externalId": "ext_01234567890123456789", "firstName": "Steve", "id": "stl_01234567890123456789", "lastName": "Kerr", "location": { "address": "120 E 34th St, New York, NY 10016, USA", "addressCity": "New York", "addressCountry": "US", "addressFirstLine": "120 E 34th St", "addressSecondarynumber": null, "addressState": "NY", "addressZip": "10016", "lat": 40.7463656, "lng": -73.9803215 }, "name": "10392", "operatingHours": { "friday": { "active": true, "shifts": [] }, "monday": { "active": true, "shifts": [] }, "saturday": { "active": true, "shifts": [] }, "sunday": { "active": true, "shifts": [] }, "thursday": { "active": true, "shifts": [] }, "tuesday": { "active": true, "shifts": [] }, "wednesday": { "active": true, "shifts": [] } }, "phoneNumber": "+16132525710", "pickupInstructions": "", "prepTimeMinutes": null, "tags": [] } ] }, "storeLocationAssociations": { "title": "Storelocationassociations", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "description": "The store location associations of the zone.", "example": [ { "endDate": "2025-01-01", "startDate": "2024-01-01", "storeLocationId": "stl_01234567890123456789" } ] }, "zoneRestrictions": { "title": "Zonerestrictions", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ZoneRestrictionResponse" } }, { "type": "null" } ], "description": "The zone restrictions of the zone.", "example": [ { "id": "res_01234567890123456789", "name": "Zone Restriction 1" } ] }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The tags of the zone.", "example": [ "service:rapid", "franchise_location" ] }, "zoneMetadata": { "title": "Zonemetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the zone.", "example": { "key": "value" } }, "isDeleted": { "title": "Isdeleted", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether the zone is deleted.", "example": false } }, "description": "Response for zone." }, "ZoneRestrictionResponse": { "title": "ZoneRestrictionResponse", "required": [ "id", "externalId", "name", "isActive", "restrictionMetadata" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "The ID of the zone restriction.", "example": "res_01234567890123456789" }, "externalId": { "title": "Externalid", "type": "string", "description": "The external ID of the zone restriction.", "example": "ext_01234567890123456789" }, "name": { "title": "Name", "type": "string", "description": "The name of the zone restriction.", "example": "Zone Restriction 1" }, "isActive": { "title": "Isactive", "type": "boolean", "description": "Whether the zone restriction is active.", "example": true }, "restrictionMetadata": { "title": "Restrictionmetadata", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "The metadata of the zone restriction.", "example": { "restriction_metadata": { "key": "value" } } } }, "description": "Response for zone restriction." }, "ZoneStoreLocationAssociationRead": { "title": "ZoneStoreLocationAssociationRead", "required": [ "storeLocationId" ], "type": "object", "properties": { "storeLocationId": { "title": "Storelocationid", "type": "string", "description": "Nash id of the associated store location." }, "startDate": { "title": "Startdate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Start of the window during which the association is active (null = always).", "default": null }, "endDate": { "title": "Enddate", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "End of the window during which the association is active (null = open-ended).", "default": null } } }, "ZoneStoreLocationRead": { "title": "ZoneStoreLocationRead", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string", "description": "Nash store location id." }, "externalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Your external id for the store location.", "default": null }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Store location name.", "default": null }, "firstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Contact first name.", "default": null }, "lastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Contact last name.", "default": null }, "phoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Contact phone number.", "default": null }, "email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Contact email.", "default": null }, "pickupInstructions": { "title": "Pickupinstructions", "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Pickup instructions for couriers.", "default": null }, "prepTimeMinutes": { "title": "Preptimeminutes", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "Order preparation time in minutes.", "default": null }, "blackoutDates": { "title": "Blackoutdates", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Dates (YYYY-MM-DD) the store is closed.", "default": null }, "operatingHours": { "title": "Operatinghours", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ], "description": "Per-weekday opening hours, keyed by day name.", "default": null }, "tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Free-form tags on the store location.", "default": null }, "location": { "anyOf": [ { "$ref": "#/components/schemas/ZoneLocationRead" }, { "type": "null" } ], "description": "Address and coordinates of the store.", "default": null } } }, "ZonesQueryRequest": { "title": "ZonesQueryRequest", "type": "object", "properties": { "ids": { "title": "Ids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Nash zone ids to fetch (max 500). Combined with `externalIds` using OR. Omit to not filter by id; an empty list matches nothing.", "default": null, "example": [ "zone_BBVtiSryYx34xCskjb2WmA" ] }, "externalIds": { "title": "Externalids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Your external zone ids to fetch (max 500). Combined with `ids` using OR. Omit to not filter by external id; an empty list matches nothing.", "default": null, "example": [ "7810BBTORQ" ] }, "isDeleted": { "title": "Isdeleted", "type": "boolean", "description": "When true, return soft-deleted zones instead of active ones.", "default": false }, "size": { "title": "Size", "type": "integer", "description": "Page size, 1 to 500. Requests above 500 return a ZONE_BULK_LIMIT_EXCEEDED error.", "default": 100 }, "offset": { "title": "Offset", "type": "integer", "description": "Number of zones to skip, for paging through the full result set.", "default": 0 } }, "description": "Body for `POST /v1/zones/query`.\n\n`ids` and `externalIds` are optional and combined with OR. Omit both to\npage through every zone in the organization; a provided but empty list\nmatches nothing.", "example": { "externalIds": [ "7810BBTORQ", "7810BBWAUR" ], "isDeleted": false, "offset": 0, "size": 100 } }, "ZonesQueryResponse": { "title": "ZonesQueryResponse", "required": [ "data", "meta" ], "type": "object", "properties": { "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/ZoneDetailRead" }, "description": "Rows for this page, in a deterministic order." }, "meta": { "$ref": "#/components/schemas/PageMeta", "description": "Pagination metadata." } }, "description": "Paginated zones, in created-at order. `data` items match `GET /v1/zones/`." }, "_NoParams": { "title": "_NoParams", "type": "object", "properties": {}, "description": "Empty parameters object for triggers that take no configuration." } }, "securitySchemes": { "Token": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT, API Key" } } }, "tags": [ { "name": "Notifications", "description": "Notifications", "x-nash-topic": "config" }, { "name": "Annotate", "description": "Annotate", "x-nash-topic": "wismo" }, { "name": "Notifications \u2014 Send", "description": "One-off notification send without a NotificationTrigger.", "x-nash-topic": "notifications" }, { "name": "Shipping", "description": "Shipping operations", "x-nash-topic": "shipping" }, { "name": "Workflow", "description": "Workflow automation management", "x-nash-topic": "scheduling" }, { "name": "Workflow Execution", "description": "Workflow execution history and monitoring", "x-nash-topic": "scheduling" }, { "name": "Optimization Strategies", "description": "Create, read, update, and delete route optimization strategies.", "x-nash-topic": "scheduling" }, { "name": "AI Agents", "description": "AI agent management \u2014 create, read, update, and delete agents", "x-nash-topic": "config" }, { "name": "AI Functions", "description": "LLM-backed domain tools", "x-nash-topic": "ai" }, { "name": "Webhooks", "description": "Webhook delivery inspection", "x-nash-topic": "webhooks" }, { "name": "Miscellaneous", "description": "Miscellaneous" }, { "name": "Job", "description": "Job", "x-nash-topic": "wismo" }, { "name": "Batch Job", "description": "Batch Job", "x-nash-topic": "wismo" }, { "name": "Order", "description": "Order", "x-nash-topic": "wismo" }, { "name": "Provider", "description": "Provider", "x-nash-topic": "provider" }, { "name": "Dispatch Strategies", "description": "Dispatch Strategies", "x-nash-topic": "scheduling" }, { "name": "Store Locations", "description": "Store Locations", "x-nash-topic": "config" }, { "name": "Delivery Windows", "description": "Delivery Windows", "x-nash-topic": "config" }, { "name": "Zones", "description": "Zones", "x-nash-topic": "config" }, { "name": "Feedback", "description": "Feedback", "x-nash-topic": "reporting" }, { "name": "Organizations", "description": "Organizations", "x-nash-topic": "config" }, { "name": "Store Catalog", "description": "Store Catalog", "x-nash-topic": "config" }, { "name": "Route", "description": "Route", "x-nash-topic": "scheduling" }, { "name": "Messaging", "description": "Messaging", "x-nash-topic": "config" }, { "name": "Billing", "description": "Invoice-aligned customer billing usage", "x-nash-topic": "config" }, { "name": "Contracts", "description": "Provider contract pricing and version listings", "x-nash-topic": "provider" }, { "name": "Couriers", "description": "Couriers", "x-nash-topic": "provider" }, { "name": "Fleet", "description": "Inbound endpoints fleets call to manage their drivers and update in-flight deliveries.", "x-nash-topic": "driver" }, { "name": "Embed Sessions", "description": "Mint short-lived, browser-safe sessions for embedded Nash Widgets. Authenticated with an org embed credential, which must stay on your backend.", "x-nash-topic": "config" }, { "name": "Event Timeline", "description": "Entity-scoped event timeline + outbound provider traffic for one entity.", "x-nash-topic": "internal" }, { "name": "Files", "description": "Stable links to files such as proof-of-delivery photos.", "x-nash-topic": "wismo" }, { "name": "Optimization Fleet Projection", "description": "Optimizer-facing projection of the effective fleet for a single-store solve", "x-nash-topic": "scheduling" }, { "name": "Hub Scanning", "description": "Scan physical packages onto their route rack at a hub.", "x-nash-topic": "scheduling" }, { "name": "Inventory", "description": "Store inventory catalog sync to SFTP retail destinations (e.g. Uber).", "x-nash-topic": "store_catalog" }, { "name": "Optimization Activities", "description": "Optimization runs launched from the portal or the API", "x-nash-topic": "scheduling" }, { "name": "Optimization Run Comparison", "description": "Why a route optimization run left orders unassigned, from the difference with the previous run", "x-nash-topic": "scheduling" }, { "name": "Optimization Run Re-solve", "description": "Whether the change since the previous run caused a run to drop orders, from solving both again", "x-nash-topic": "scheduling" }, { "name": "Dispatch plans", "description": "Draft dispatch plans: the orders and routes a dispatcher is planning before release.", "x-nash-topic": "scheduling" }, { "name": "Route Restrictions", "description": "Org-scoped geographic areas the route optimizer must avoid traversing.", "x-nash-topic": "config" }, { "name": "Driver Scheduling", "description": "Assign drivers to fixed loads across days under US hours-of-service rules", "x-nash-topic": "scheduling" }, { "name": "Shifts", "description": "Shifts", "x-nash-topic": "provider" }, { "name": "Templates", "description": "Templates", "x-nash-topic": "config" }, { "name": "Users", "description": "User, role, and organization-membership management.", "x-nash-topic": "config" }, { "name": "Vehicles", "description": "Vehicles", "x-nash-topic": "provider" }, { "name": "Widgets", "description": "Org configuration for embedded Nash Widgets: parent origins, enablement, and embed credentials.", "x-nash-topic": "config" }, { "name": "Conversation Agent", "description": "Inbox conversation context and team-only whispers for Nash's conversation agent.", "x-nash-topic": "internal" }, { "name": "Driver Chat", "description": "Operator-approved messages from Nash's route agent to the route's driver.", "x-nash-topic": "internal" }, { "name": "Integration Health", "description": "Aggregate API errors", "x-nash-topic": "internal" }, { "name": "Provider Chat", "description": "Carrier-chat context for a route, scoped to the caller's organization.", "x-nash-topic": "internal" }, { "name": "Order Ingestion", "description": "Internal validate, commit, and reconciliation boundary for governed Order imports.", "x-nash-topic": "internal" } ] }