Skip to content

Get a job

Request

Returns a single job by its external ID. Implementation is required.

Tax note: Every accrual must include numeric tax values in both local_amount and overseas_amount, and a tax_code key. For non-tax accounts, including US-based accounts without GST/VAT, send tax: 0.0 and tax_code: null; do not omit these fields or send null for tax.

Jobs contain nested accruals, container numbers, waybills, and additional references. When a job is updated (including changes to accruals, child shipments added to a consol, etc.), the updated_at timestamp must reflect the most recent change.

Security
OAuth2.0-Partner or Bearer-Token-Partner
Path
external_idstring, non-emptyrequired

The unique, immutable identifier for the entity in the FFS.

curl -i -X GET \
  'https://apidocs.bravotran.com/_mock/openapi/jobs/{external_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Job details

Bodyapplication/json
external_idstring, non-emptyrequired

Unique, immutable identifier for this job.

updated_atstring, (date-time)required

ISO 8601 timestamp of when this job was last updated. Must update whenever any nested data changes (accrual added/edited, shipment linked, etc.).

job_numberstring, non-emptyrequired

Human-friendly identifier for the job.

job_typestringrequired

Type of job:

  • consol — Consolidation of child jobs (master)
  • shipment — Stand-alone job or child of a consol (house)
Enum:"consol""shipment"
statusstringrequired

Current status of the job in the FFS.

parent_jobsArray of objects, <= 1 items(EntityRef)

References to parent jobs. Holds at most one parent job today; modeled as an array so a later version can allow more.

child_jobsArray of objects(EntityRef)

References to child jobs. Typically present on consols.

operatorobject(EntityRef)required

Reference to the staff member responsible for this job. BravoTran notifies this operator about inaccurate or missing accruals so they can fix them.

accrualsArray of objects(Accrual)required

Expected charges on this job. Send even if the job has no accruals (empty array).

container_numbersArray of strings

Container numbers associated with this job.

way_billsArray of objects(WayBill)

Waybills associated with this job.

additional_referencesArray of objects(AdditionalReference)

Any additional reference data for this job.

Response
{
  "external_id": "db3b1f33-2335-4fc5-a874-f8284a95d539",
  "updated_at": "2025-02-17T20:32:39Z",
  "job_number": "S631234",
  "job_type": "shipment",
  "status": "open",
  "parent_jobs": [
    { … }
  ],
  "child_jobs": [],
  "operator": {
    "external_id": "a7ed2209-b471-4c37-90f5-bfea1e7bb464"
  },
  "accruals": [
    { … },
    { … }
  ],
  "container_numbers": [
    "MEDU5338992",
    "SEGU2901100"
  ],
  "way_bills": [
    { … }
  ],
  "additional_references": [
    { … }
  ]
}