Skip to main content

Update Additional Item

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

Update additional item for a job.

Roles​

Users with the following roles may access this endoint:

Dispatcher
Driver
ThirdPartyDispatcher
ThirdPartyDriver

Breaking Changes​

No breaking changes.

Request​

PATCH /locations/{location_id}/jobs/{job_id}/additional_items/{job_item_id}/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"deduct_weight": 7,
"description": "An updated desc.",
"heavy_weight": 5,
"is_completed": true,
"is_declined": true,
"is_failed": true,
"light_weight": 6,
"material_item_id": 1,
"notes": "Some updated notes.",
"quantity": 8
}

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.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

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​

Refer to UpdateAdditionalItemModel for more details.

deduct_weight Float, Optional

  • Greater than or equal to 0.

description String, Optional

Item description.

  • At least 0 and no more than 2048 characters.

heavy_weight Float, Optional

  • Greater than or equal to 0.

is_completed Boolean, Optional

Completion flag.

  • One of 0, 1, True, False (case insensitive).

is_declined Boolean, Optional

Declined flag.

  • One of 0, 1, True, False (case insensitive).

is_failed Boolean, Optional

Failed flag.

  • One of 0, 1, True, False (case insensitive).

light_weight Float, Optional

  • Greater than or equal to 0.

material_item_id Integer, Optional

Material item identifier.

notes String, Optional

Item notes.

  • At least 0 and no more than 2048 characters.

quantity Float, Optional

Item quantity.

  • Greater than or equal to 0.

Response​

Response Headers​

Refer to StandardResponseHeadersModel for more details.

Content-Type String, Optional

Default Value: application/json

One of the following MIME types:

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 AdditionalItemModel for more details.

deduct_weight Float

  • Greater than or equal to 0.

description String

Item description.

  • At least 0 and no more than 2048 characters.

heavy_weight Float

  • Greater than or equal to 0.

id Integer

Additional item identifier.

is_completed Boolean

Completion flag.

  • One of 0, 1, True, False (case insensitive).

is_declined Boolean

Declined flag.

  • One of 0, 1, True, False (case insensitive).

is_failed Boolean

Failed flag.

  • One of 0, 1, True, False (case insensitive).

job_id Integer

Job identifier.

light_weight Float

  • Greater than or equal to 0.

material_item_id Integer

Material item identifier.

notes String

Item notes.

  • At least 0 and no more than 2048 characters.

quantity Float

Item quantity.

  • Greater than or equal to 0.

Code Samples​

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("Content-Type", "application/json");
        client.Headers.Add("x-tenant-id", "{your-tenant-id}");

        // Body
        String body = "{\"deduct_weight\": 7, \"description\": \"An updated desc.\", \"heavy_weight\": 5, \"is_completed\": true, \"is_declined\": true, \"is_failed\": true, \"light_weight\": 6, \"material_item_id\": 1, \"notes\": \"Some updated notes.\", \"quantity\": 8}";

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