Override Duty Estimate

PUT 
/api/duty-estimates/:dutyEstimate/override

Sets a manual duty amount (base currency) on a purchase order or inbound shipment duty estimate, replacing the calculated total; status becomes overridden. The override is carried forward pro rata to later stages (shipment, then receipt) until cleared. Send override_amount: null to clear it and restore the calculated estimate.

Required scope: purchase-orders:write

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

Body:

• override_amount (required, number|null, min 0)
• reason (string, max 255; required when override_amount is not null)

Receipt estimates are frozen at receipt and return 422.

Authentication: Requires Bearer token (scope purchase-orders:write, permission purchase_orders.update).

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not Found

Response Headers

Content-Type

422

Unprocessable Entity

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.