Share Consignment Settlement Report
POST/api/consignment/settlements/:settlement/share
Share a consignment settlement's Account Sales Report with the supplier. The report is term-aware — it states how much is owed and when it is due, derived from the consignment payment term on the purchase order.
Request body:
- channel (required): how to share — email, portal, or both.
- recipient_email (optional): the address to email the report to. When omitted, the supplier's own contact email is used. Ignored when channel is portal.
A public, unauthenticated portal link is always returned so it can be copied and shared directly. The portal page shows the supplier the amount owed, the due date, the line items that sold, and the payment terms.
Authentication: Requires a Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
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.