Create Additional Item
POST /locations/{location_id}/jobs/{job_id}/additional_items
Create 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
- Sample Request
- Sample Response
POST /locations/{location_id}/jobs/{job_id}/additional_items/
Authorization: Bearer {your-auth-token}
Content-Type: application/json
x-tenant-id: {your-tenant-id}
{
"deduct_weight": 3,
"description": "A desc.",
"heavy_weight": 1,
"is_completed": false,
"is_declined": false,
"is_failed": false,
"light_weight": 2,
"material_item_id": 1,
"notes": "Some notes.",
"quantity": 4
}
Access-Control-Allow-Headers: Authorization, Accept, X-TENANT-ID, Content-Type
Access-Control-Allow-Methods: POST
Access-Control-Allow-Origin: *
Allow: POST
Content-Length: 137
Content-Type: application/json
Date: Sat, 20 Aug 2022 01:42:36 GMT
Server: WSGIServer/0.2 CPython/3.9.5
X-API-VERSION: 2019/02/08
X-REQUEST-ID: d6e83439-278e-4679-a507-a465102b4d35
{
"deduct_weight": 3,
"description": "A desc.",
"heavy_weight": 1,
"id": 5157,
"light_weight": 2,
"notes": "Some notes.",
"quantity": 4.0
}
Path Parameters
job_id Integer, Required
Job identifier.
location_id Integer, Required
Location identifier.
Query Parameters
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:
- "application/json" Refer to the JSON Spec.
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 CreateAdditionalItemModel for more details.
deduct_weight Float, Required
- Greater than or equal to 0.
description String, Required
Item description.
- At least 0 and no more than 2048 characters.
heavy_weight Float, Required
- Greater than or equal to 0.
is_completed Boolean, Required
Completion flag.
- One of 0, 1, True, False (case insensitive).
is_declined Boolean, Required
Declined flag.
- One of 0, 1, True, False (case insensitive).
is_failed Boolean, Required
Failed flag.
- One of 0, 1, True, False (case insensitive).
light_weight Float, Required
- Greater than or equal to 0.
material_item_id Integer, Required
Material item identifier.
notes String, Required
Item notes.
- At least 0 and no more than 2048 characters.
quantity Float, Required
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:
- "application/json" Refer to the JSON Spec.
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
- cURL
- Python
- CSharp 2.0
curl --request POST --include \
--header "Authorization: Bearer {your-auth-token}" \
--header "Content-Type: application/json" \
--header "x-tenant-id: {your-tenant-id}" \
--data '{"deduct_weight": 3, "description": "A desc.", "heavy_weight": 1, "is_completed": false, "is_declined": false, "is_failed": false, "light_weight": 2, "material_item_id": 1, "notes": "Some notes.", "quantity": 4}' \
127.0.0.1:8003/locations/{location_id}/jobs/{job_id}/additional_items
import requests, json
body = '''
{
"deduct_weight": 3,
"description": "A desc.",
"heavy_weight": 1,
"is_completed": false,
"is_declined": false,
"is_failed": false,
"light_weight": 2,
"material_item_id": 1,
"notes": "Some notes.",
"quantity": 4
}
'''
response = requests.post(
'http://localhost:8003/locations/{location_id}/jobs/{job_id}/additional_items',
headers={
'Authorization': 'Bearer {your-auth-token}',
'Content-Type': 'application/json',
'x-tenant-id': '{your-tenant-id}'
},
params={
},
data=body
)
results = json.loads(response.text)
print(results)
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";
// 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\": 3, \"description\": \"A desc.\", \"heavy_weight\": 1, \"is_completed\": false, \"is_declined\": false, \"is_failed\": false, \"light_weight\": 2, \"material_item_id\": 1, \"notes\": \"Some notes.\", \"quantity\": 4}";
String json = client.UploadString(url, "post", body);
Console.WriteLine(json);
}
}
}