Skip to main content

Update Dropship Label

PATCH 
/api/dropship-labels/:dropshipLabel

Reschedules a scheduled label to a new ship date, or buys it immediately.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body fields:

  • ready (string, optional): now buys the label immediately; date (or omitted) reschedules
  • ship_date (string, required unless ready=now, Y-m-d): today or later in the supplier's timezone, at most 90 days ahead

Returns the updated label.

Domain failures return 422 with {message, reason} where reason is one of: no_provider (no label-capable shipping integration is assigned to the supplier or set as the default), not_eligible (the purchase order cannot get a label — e.g. not a dropship order, closed, or the supplier uses their own labels), purchase_failed (the carrier/provider refused the purchase), already_in_progress, relabel_limit_reached, invalid_state (the label's status does not allow the action) or provider_unavailable (the shipping provider could not be reached).

Label objects include label_file_count (number of downloadable label files, one per package; 0 until purchased) — pass a zero-based index below it as package to Download Dropship Label. portal_url (on each label and at the top level) is returned only to users with the purchase_orders.update permission — and, when calling with a Personal Access Token, only if the token has the purchase-orders:write scope; otherwise it is null. The link carries the supplier's share token, which lets its holder buy, re-label and void labels.

Authentication: Requires Bearer token.

Requires permission: purchase_orders.update

Request​

Responses​

OK

Response Headers
    Content-Type