JobShipment
Manage shipment details within jobs including tracking, carrier assignments, and delivery confirmation.
Quick Reference
Method |
Endpoint |
Description |
|---|---|---|
POST |
/api/job/{jobDisplayId}/shipment/book |
|
DELETE |
/api/job/{jobDisplayId}/shipment |
|
GET |
/api/job/{jobDisplayId}/shipment/ratequotes |
|
POST |
/api/job/{jobDisplayId}/shipment/ratequotes |
|
GET |
/api/job/{jobDisplayId}/shipment/origindestination |
|
GET |
/api/job/{jobDisplayId}/shipment/accessorials |
|
POST |
/api/job/{jobDisplayId}/shipment/accessorial |
|
DELETE |
/api/job/{jobDisplayId}/shipment/accessorial/{addOnId} |
|
GET |
/api/job/{jobDisplayId}/shipment/ratesstate |
|
GET |
/api/job/{jobDisplayId}/shipment/exportdata |
|
POST |
/api/job/{jobDisplayId}/shipment/exportdata |
POST /api/job/{jobDisplayId}/shipment/book
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.post(
"/api/job/{jobDisplayId}/shipment/book"
,
jobDisplayId="2000000"
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw post /api/job/{jobDisplayId}/shipment/book \
jobDisplayId=2000000
curl -X POST \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/shipment/book'
Sample Response:
1{
2 "id": "789e0123-e89b-12d3-a456-426614174002",
3 "status": "created",
4 "message": "Resource created successfully"
5}
DELETE /api/job/{jobDisplayId}/shipment
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.delete(
"/api/job/{jobDisplayId}/shipment"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw delete /api/job/{jobDisplayId}/shipment \
jobDisplayId=2000000
curl -X DELETE \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/shipment'
Sample Response:
1{
2 "status": "success",
3 "message": "Resource deleted successfully"
4}
GET /api/job/{jobDisplayId}/shipment/ratequotes
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Query Parameters:
ShipOutDate (string, query): No description available
RatesSources (array, query): No description available
SettingsKey (string, query): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/shipment/ratequotes"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/shipment/ratequotes \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/shipment/ratequotes'
Sample Response:
1[]
POST /api/job/{jobDisplayId}/shipment/ratequotes
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.post(
"/api/job/{jobDisplayId}/shipment/ratequotes"
,
jobDisplayId="2000000"
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw post /api/job/{jobDisplayId}/shipment/ratequotes \
jobDisplayId=2000000
curl -X POST \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/shipment/ratequotes'
Sample Response:
1{
2 "id": "789e0123-e89b-12d3-a456-426614174002",
3 "status": "created",
4 "message": "Resource created successfully"
5}
GET /api/job/{jobDisplayId}/shipment/origindestination
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/shipment/origindestination"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/shipment/origindestination \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/shipment/origindestination'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}
GET /api/job/{jobDisplayId}/shipment/accessorials
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/shipment/accessorials"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/shipment/accessorials \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/shipment/accessorials'
Sample Response:
1[]
POST /api/job/{jobDisplayId}/shipment/accessorial
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.post(
"/api/job/{jobDisplayId}/shipment/accessorial"
,
jobDisplayId="2000000"
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw post /api/job/{jobDisplayId}/shipment/accessorial \
jobDisplayId=2000000
curl -X POST \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/shipment/accessorial'
Sample Response:
1{
2 "id": "789e0123-e89b-12d3-a456-426614174002",
3 "status": "created",
4 "message": "Resource created successfully"
5}
DELETE /api/job/{jobDisplayId}/shipment/accessorial/{addOnId}
Parameters:
Path Parameters:
addOnId (integer, path) (required): No description available
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.delete(
"/api/job/{jobDisplayId}/shipment/accessorial/{addOnId}"
,
addOnId="789e0123-e89b-12d3-a456-426614174002"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw delete /api/job/{jobDisplayId}/shipment/accessorial/{addOnId} \
addOnId=789e0123-e89b-12d3-a456-426614174002 \
jobDisplayId=2000000
curl -X DELETE \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/shipment/accessorial/789e0123-e89b-12d3-a456-426614174002'
Sample Response:
1{
2 "status": "success",
3 "message": "Resource deleted successfully"
4}
GET /api/job/{jobDisplayId}/shipment/ratesstate
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/shipment/ratesstate"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/shipment/ratesstate \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/shipment/ratesstate'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}
GET /api/job/{jobDisplayId}/shipment/exportdata
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.get(
"/api/job/{jobDisplayId}/shipment/exportdata"
,
jobDisplayId="2000000"
)
# Process the response
print(response)
ab api raw get /api/job/{jobDisplayId}/shipment/exportdata \
jobDisplayId=2000000
curl -X GET \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
'https://api.abconnect.co/api/job/2000000/shipment/exportdata'
Sample Response:
1{
2 "status": "success",
3 "data": {}
4}
POST /api/job/{jobDisplayId}/shipment/exportdata
Parameters:
Path Parameters:
jobDisplayId (string, path) (required): No description available
Example Request:
from ABConnect import ABConnectAPI
# Initialize the API client
api = ABConnectAPI()
# Make the API call
response = api.raw.post(
"/api/job/{jobDisplayId}/shipment/exportdata"
,
jobDisplayId="2000000"
,
data=
{
"example": "data"
}
)
# Process the response
print(response)
ab api raw post /api/job/{jobDisplayId}/shipment/exportdata \
jobDisplayId=2000000
curl -X POST \
-H 'Authorization: Bearer YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"example": "data"
}' \
'https://api.abconnect.co/api/job/2000000/shipment/exportdata'
Sample Response:
1{
2 "id": "789e0123-e89b-12d3-a456-426614174002",
3 "status": "created",
4 "message": "Resource created successfully"
5}