/drafts/{transportDraftId}/actions

Create and execute an action on a transport draft. Supported actions include adding products, submitting the draft, sending/accepting/declining shipper offers, managing the draft lifecycle, and — for recurring masters — the four lifecycle transitions activate-recurring, pause-recurring, resume-recurring, end-recurring. Same-direction lifecycle calls (e.g. pause-recurring on an already-paused master) are idempotent and return 200 without a state change.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the transport draft to perform the action on

Body Params

Action to perform on the transport draft

string
enum
required
Allowed:
properties
object
required

Custom property values to set on the draft, keyed by the tenant's PropertyDefinition id.

Responses

400

bad request

401

unauthorized

404

transport draft not found

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json