Skip to main content

Update Dropship Branding

PUT 
/api/portal/dropship/branding

Updates the packing-slip branding. Only the fields sent are changed; omit a field to keep it. Orders already placed keep the branding they were placed with.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Body (every field optional)

  • display_name (string or null, max 255) — may not be blank when sent.
  • support_email (email or null, max 255).
  • support_phone (string or null, max 64).
  • slip_message (string or null, max 2000).
  • return_address (object or null; null clears it). When sent: name, address1, city and country_code (2-letter ISO) are required; company, address2, address3, province, province_code (max 16), zip (max 32), country, phone (max 64) and email are optional (strings, max 255 unless noted).

The logo is uploaded separately with Upload Dropship Logo.

Returns 422 for invalid fields. Returns 403 with code: dropship_branding_not_allowed and a message saying why when the buyer is not a company admin, dropship is not turned on for the account, or the merchant manages the branding itself. Viewers get 403 viewer_read_only.

Request​

Responses​

OK

Response Headers
    Content-Type