USusenash
Batch Job

Create Batch Job

Changed on

Create a batch job containing multiple packages for multi-stop delivery. Each package has its own pickup and dropoff locations within a single job.

post/v1/batch_job

Request

Request body

jobMetadataobject nullable
optionsGroupIdstring nullable
externalIdentifierstring nullable
inputDatetimesLocalizedToPickupTzboolean

Example request

{
  "packages": [
    {
      "pickupAddressComponents": {
        "number": "1600",
        "street": "Pennsylvania Avenue NW",
        "county": "Washington",
        "city": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "country": "US",
        "latitude": 38.8948949,
        "longitude": -77.0371581
      },
      "dropoffAddressComponents": {
        "number": "1600",
        "street": "Pennsylvania Avenue NW",
        "county": "Washington",
        "city": "Washington",
        "state": "DC",
        "postalCode": "20500",
        "country": "US",
        "latitude": 38.8948949,
        "longitude": -77.0371581
      },
      "packageMinimumVehicleSize": "car",
      "packageRequirements": [
        "photo_proof_of_delivery",
        "age_verification_on_delivery"
      ]
    }
  ]
}

Response

OK

idstring required

Job ID

createdAtstring required

Created at

portalUrlstring required

Portal URL

externalIdentifierstring nullable

External identifier

jobMetadataobject nullable

Job metadata

isActiveboolean required

Is the job active

isBatchboolean required

Is the job a batch

shortReferenceCodestring nullable

Short, non-unique human-readable reference code for the job.

Changes

  • e3713837c5c9Revision changes
    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/statusHistory/anyOf[subschema #1]/items/additionalProperties/ list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/stops/items/distanceFromPrevious list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/stops/items/durationFromPrevious list-of-types was widened by adding types integer to media type application/json of response 200

    • breaking

      response property route/anyOf[subschema #1: RouteSerializer]/stops/items/serviceTime list-of-types was widened by adding types integer to media type application/json of response 200

    • warning

      added the new cargo_bike enum value to the /// response property for the response status

    • info

      added the new cargo_bike enum value to the request property //

    • info

      added the optional property / to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///////////// to the response with the status