Upload Sales Credit Document

POST 
/api/sales-credits/:salesCredit/attachments

Uploads a supporting document to the sales credit.

Required scope: orders:write

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

Authentication: Requires Bearer token.

Send the file as multipart/form-data under the file key. Accepted types: PDF, PNG, JPG, JPEG, WEBP. Maximum size: 20 MB. Empty files are rejected.

Returns 422 when the credit is archived — archived credits are read-only history.

Request

Responses

201

Created

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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Content

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.