62 lines
1.4 KiB
Markdown
62 lines
1.4 KiB
Markdown
# PATCH /integrations/parts-management/job/:id/status
|
|
|
|
Update (patch) the status of a job created under parts management. This endpoint is only available
|
|
for jobs whose parent bodyshop has an `external_shop_id` (i.e., is provisioned for parts
|
|
management).
|
|
|
|
## Endpoint
|
|
|
|
```
|
|
PATCH /integrations/parts-management/job/:id/status
|
|
```
|
|
|
|
- `:id` is the UUID of the job to update.
|
|
|
|
## Request Headers
|
|
|
|
- `Authorization`: (if required by your integration middleware)
|
|
- `Content-Type: application/json`
|
|
|
|
## Request Body
|
|
|
|
Send a JSON object with the following field:
|
|
|
|
- `status` (string, required): The new status for the job.
|
|
|
|
Example:
|
|
|
|
```
|
|
PATCH /integrations/parts-management/job/123e4567-e89b-12d3-a456-426614174000/status
|
|
Content-Type: application/json
|
|
|
|
{
|
|
"status": "IN_PROGRESS"
|
|
}
|
|
```
|
|
|
|
## Success Response
|
|
|
|
- **200 OK**
|
|
- Returns the updated job object with the new status.
|
|
|
|
```
|
|
{
|
|
"id": "123e4567-e89b-12d3-a456-426614174000",
|
|
"status": "IN_PROGRESS",
|
|
...
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
- **400 Bad Request**: Missing status field, or parent bodyshop does not have an `external_shop_id`.
|
|
- **404 Not Found**: No job found with the given ID.
|
|
- **500 Internal Server Error**: Unexpected error.
|
|
|
|
## Notes
|
|
|
|
- Only jobs whose parent bodyshop has an `external_shop_id` can be patched via this route.
|
|
- Fields other than `status` will be ignored if included in the request body.
|
|
- The route is protected by the same middleware as other parts management endpoints.
|
|
|