Create a Dispatch Job.

Create a new dispatching job with the provided data.

SecurityAPIKeyHeader
Request
Request Body schema: application/json
required
Preferred Currency (string) or Preferred Currency (null) (Preferred Currency)
Default: "USD"

Rates will be returned in this currency if available. Expected valid ISO 4217 three-letter standard currency codes

Locale (string) or Locale (null) (Locale)
Default: "en-US"

Messages will be returned using this locale if supported

mode
required
string (TransportationMode)

Transportation mode for this dispatch

Enum: "DRAYAGE" "FTL" "GTD" "GTE" "LTL" "PARCEL" "RAIL"
provider_code
required
string (ProviderCode)

The code identifying the target capacity provider. Used for dispatching.

Enum: "AMAZON" "CHROBINSON" "SMC3" "UBER" "FEDEX" "SHIPWELL_FTL" "UPS" "USPS" "PUROLATOR" "CANPAR" "CANADAPOST" "RLC" "XPO" "ODFL" "ESTES" "WARD" "CLOUDTRUCKS" "ABF" "ANY" "CENTRALTRANSPORT" "PRIMO" "SAIA"
status
string (DispatchStatus)
Default: "PROCESSING"

The current status of the dispatch request, indicating its progress or state.

Enum: "PROCESSING" "ERRORED" "DECLINED" "CANCELLING" "CANCELLED" "EXPIRED" "REVOKED" "COMPLETED"
resource_type
required
string (ResourceType)

Type of resource that caused the dispatch request, such as 'shipment', 'order', etc.

Enum: "SHIPMENT" "EBOL_REQUEST"
resource_id
required
string (Resource Id)

ID of the resource that caused the dispatch request if available.

Quote Id (string) or Quote Id (null) (Quote Id)

Reference to Shipwell quote ID if available. This field is required for CHRobinson dispatches.

Notes For Carrier (string) or Notes For Carrier (null) (Notes For Carrier)

Optional notes or instructions intended for the carrier to assist with the dispatch process.

Array of objects (References)

Reference for this Shipment

source_type
required
string (Source Type)
Value: "RATE"
rate_id
required
string (Rate Id)
CommonContact (object) or null

Contact information for the origin stop. Required by some carriers.

CommonContact (object) or null

Contact information for the destination stop. Required by some carriers.

Responses
202

Successful Response

400

Validation Error

404

The resource requested was not found either because you do not have permissions to access it or it does not exist.

409

The resource being updated or created already exists.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

post/dispatching
Request samples
application/json
{
  • "mode": "LTL",
  • "source_type": "RATE",
  • "provider_code": "RLC",
  • "resource_type": "SHIPMENT",
  • "resource_id": "5ee55de4-5e68-4b21-87b1-69fff7a5e0ae",
  • "tenant_id": "tenant_id_1",
  • "quote_id": "01KJ7ZZDV4NM9FTVVS71HYGWYR",
  • "notes_for_carrier": null,
  • "rate_id": "01KJ7ZZHWZCPRCCEV4DQ4J7SV1",
  • "origin_contact": {
    },
  • "destination_contact": {
    }
}
Response samples
application/json
{
  • "id": "string"
}
Copyright © Shipwell 2025. All right reserved.