v1

latestOpenAPI 3.0.12026-07-243902.3 MB

service-orders

Update a service order

post/service-orders/{serviceOrderId}/update-repair

Path parameters

serviceOrderIdstring uuid required

Example:cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf

Unique identifier for a service order

Headers

Content-Typestring required

Example:application/json

Used to indicate the original media type of the resource (prior to any content encoding applied for sending).

X-Extend-Access-Tokenstring required

Example:ExtendAccessToken

An Extend private API key used to authenticate requests.

Acceptstring required

Example:application/json; version=latest

Indicates which content types, expressed as MIME types, the client is able to understand, as well as identifies which API version to use in the request.

Request body

eventstring required

The name of the event

receivedBystring

Associated with 'product_received' event

receivedAtnumber

Associated with 'product_received' event

deliveredTostring

Associated with 'product_delivered' event

deliveredAtnumber

Associated with 'product_delivered' event

diagnosedBystring

Associated with 'product_diagnosed' event

diagnosticExplanationstring

Associated with 'product_diagnosed' event

diagnosticCompletedAtnumber

Associated with 'product_diagnosed' event

isDelayedboolean

Associated with 'repair_eta' event

delayReasonstring

Associated with 'repair_eta' event

estimatedRepairCompletionAtnumber

Associated with 'repair_eta' event

repairStartedAtnumber

Associated with 'repair_started' event

repairCompletedAtnumber

Associated with 'repair_completed' event

repairShippedAtnumber

Associated with 'repair_shipped' event

repairExplanationstring

Associated with 'repair_completed' event

partManagementEventType'parts_needed' | 'parts_ordered' | 'parts_shipped' | 'parts_delivered'

Associated with 'part_management' event

appointmentEventType'scheduled' | 'rescheduled' | 'cancelled'

Associated with 'appointment_scheduling' event

appointmentDatenumber

Associated with 'appointment_scheduling' event

customerContactEventType'appointment_reminder' | 'schedule_attempt_failure' | 'appointment_requested' | 'appointment_request_confirmed'

Associated with 'customer_contact' event

method'email' | 'phone' | 'email_and_phone'

Associated with 'customer_contact' event

contactTimestampnumber

Associated with 'customer_contact' event

appointmentTimestampsnumber[]

Associated with 'customer_contact' event

availabilityWindowsnumber[]

Associated with 'batched' event

resolutionType'closed' | 'fulfilled'

Associated with 'resolved' event

reason'no_service_required' | 'new_service_needed' | 'additional_servicing_required' | 'defective_product_not_shipped'

Associated with 'resolved' event

metadataobject

JSON Object containing metadata for other events

eventDatenumber

Date associated with other events

notesstring

Optional notes field for any event

Response

Updates a service order

idstring required