Sign in
/shipping/orders/drafts

Open draft

Opens a new draft order shell with org assignments based on caller's organization type. | authz: min_org_role=operator | (OrdersOpenDraftReq) -> (OrdersOpenDraftRes)

post/shipping/orders/drafts/open/v1

Request body

service_line'on_demand' | 'routed'
coordinator_org_idstring nullable

Must be a string starting with org_

shipper_org_idstring nullable

Must be a string starting with org_

off_chrt_shipper_org_data_idstring nullable
off_chrt_reference_idstring nullable

Must be a URL-safe string of 1-64 characters. Allowed characters: A-Z, a-z, 0-9, '.', '_', '~', '-' (RFC 3986 unreserved).

department_idsstring[]
labelsstring[]
creation_idempotency_keystring nullable

Optional key, unique per caller org, that makes draft creation idempotent: re-sending the same key returns the already-created draft instead of creating a duplicate.

Response

Successful Response

order_idstring required
order_short_idstring required

Changes

Changed in 2 of the 9 revisions of this API.24

  • 90f02389cb0d11See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cf36112567513See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog