Delete Additional Item

DELETE /locations/{location_id}/jobs/{job_id}/additional_items/{job_item_id}

Delete additional item for a job. Drivers may only delete items not marked as required.

Roles

Users with the following roles may access this endoint:

Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes

No breaking changes.

Request

Sample Request

DELETE /locations/{location_id}/jobs/{job_id}/additional_items/{job_item_id}/
Authorization: Bearer {your-auth-token}
x-tenant-id: {your-tenant-id}

Sample Response

Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: PATCH,DELETE
Access-Control-Allow-Origin: *
Allow: PATCH,DELETE
Content-Length: 0
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:42:49 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: d1a4be65-6c6a-499c-99d2-bae08717dfd9

{}

Path Parameters

job_id Integer, Required

Job identifier.

---

job_item_id Integer, Required

Additional item identifier.

---

location_id Integer, Required

Location identifier.

Query Parameters

note

No query parameters.

Request Headers

Refer to StandardRequestHeadersModel for more details.

authorization String, Required

Authorization header (bearer with access token). See the Authentication Guide to get started.

• Matches ^bearer [a-z0-9-_=]+.[a-z0-9-_=]+.?[a-z0-9-_.+/=]*$
• No longer than 256 characters.
• At least 1 characters long.

---

x-api-version String, Optional

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-tenant-id Integer, Required

Tenant identifier. Contact CRO Software for more info if you don't already have this id. See list tenant ids for info on listing the tenants you have access to.

Request Body

note

No request body

Response

Response Headers

Refer to StandardResponseHeadersModel for more details.

x-api-version String

Request identifier.

• At least 1 and no more than 64 characters.
• Must be a valid API version string (2019/02/08, 2021/04/07, 2021/05/07, 2021/08/02, 2021/11/04, 2023/04/19).

---

x-request-id String

Request identifier.

• Valid UUID.

Response Body

Refer to EmptyContentResponseModel for more details.

Code Samples

cURL

curl --request DELETE --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "x-tenant-id: {your-tenant-id}" \
--data '""' \
127.0.0.1:8003/locations/{location_id}/jobs/{job_id}/additional_items/{job_item_id}

Python

import requests, json

body = '''
    ""
    '''
response = requests.post(
        'http://localhost:8003/locations/{location_id}/jobs/{job_id}/additional_items/{job_item_id}',
        headers={
            'Authorization': 'Bearer {your-auth-token}',
            'x-tenant-id': '{your-tenant-id}'
        },
        params={
        },
        data=body
    )
results = json.loads(response.text)
print(results)

CSharp 2.0

using System;
using System.Net;
using System.Collections.Specialized;

namespace CROSoftware
{
public class DemoClient
{
    static public void Main ()
    {
        WebClient client = new WebClient();

        // URL    
        String url = "/locations/{location_id}/jobs/{job_id}/additional_items/{job_item_id}";

        // Headers
        client.Headers.Add("Authorization", "Bearer {your-auth-token}");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        // Body
        String body = "";

        String json = client.UploadString(url, "delete", body);
        Console.WriteLine(json);
    }
}
}