List one credit account's debits and credits

GET

/credit-accounts/{creditAccountId}/adjustments

curl --request GET \
  --url https://api.partners.collaterate.com/v1/credit-accounts/1/adjustments \
  --header 'Authorization: Bearer <token>'

• Production (OAuth2 client_credentials, bearer token)
• Production (mutual TLS -- see "Authentication" below; only for partners onboarded this way)
• Staging (OAuth2 client_credentials, bearer token)
• Staging (mutual TLS)
• Test-B (OAuth2 client_credentials, bearer token)
• Test-B (mutual TLS)

The ledger for one account: every movement, and the order that caused it. Keyset-paginated with the same cursor/limit contract as the other collections.

type is a raw movement code and the set is open - PRODUCT_DEBIT, TAX_DEBIT, SHIPPING_DEBIT, ORDER_HANDLING_DEBIT, ORDER_ITEM_HANDLING_DEBIT and their _CREDIT reversals are the ten values in use today, but there is no enumeration behind them upstream. Match on the _DEBIT/_CREDIT suffix rather than listing the ten.

:::note Adjustments made by test orders are omitted, because their order numbers are not resolvable through GET /v1/orders. They are rare - about 1 in 2,000 - but it does mean a page of adjustments need not sum exactly to the difference between amount and currentBalance. :::

Authorizations

• oauth2
  partner-api/credit:read
• mtls

Parameters

Path Parameters

creditAccountId

required

integer format: int32

>= 1

At most nine digits.

Query Parameters

type

string

/^[A-Z][A-Z0-9_]{0,63}$/

Only this movement code, matched exactly. An unknown but well-formed code returns an empty page rather than an error.

cursor

string

limit

integer

>= 1 <= 200

Page size. Defaults to 50, capped at 200.

Responses

200

A page of adjustments. May be empty.

Media typeapplication/json

object

adjustments

required

Array<object>

One movement against a credit account - a debit that spent some of it, or a credit that gave some back - and the order that caused it.

amount is a decimal string, on the same terms as CreditAccount.amount.

object

amount

required

The amount moved, as an exact decimal string. Do not parse as a float.

string | null

type

required

The movement code, e.g. PRODUCT_DEBIT. The set is open - there is no enumeration behind it upstream, so match on the _DEBIT/_CREDIT suffix rather than on a fixed list of values.

string | null

orderNumber

required

The order that moved the money. Resolve it with GET /v1/orders/{orderNumber}.

integer format: int32

postedOn

required

string format: date-time

nextCursor

required

string | null

Example^generated

{
  "adjustments": [
    {
      "amount": "example",
      "type": "example",
      "orderNumber": 1,
      "postedOn": "2026-04-15T12:00:00Z"
    }
  ],
  "nextCursor": "example"
}

400

The creditAccountId, type or cursor is malformed (invalid_credit_account_id, invalid_adjustment_type, invalid_cursor), or any other query parameter this endpoint does not accept (unknown_query_parameter).

Media typeapplication/problem+json

RFC 9457 application/problem+json body. code is the published, stable, machine-readable field to branch your integration logic on – detail is a human-readable string that may be reworded over time and must not be parsed.

This table is the whole published set: every code this API can return appears below, and nothing below is unreachable. test/docs/openapi-matches-reality.test.ts compares the enum to the codes the handlers actually construct, so a code added to one side and not the other fails the build rather than shipping.

Published code values:

code	HTTP status	Meaning	Retry?
invalid_cursor	400	The cursor query parameter could not be decoded.	No – restart pagination with no cursor. Do not resend the same value.
invalid_site_id	400	The siteId filter is not a positive integer, or it names a site outside your grant. detail says which.	No – fix the parameter against GET /v1/me’s grantedSiteIds.
invalid_order_number	400	The order number in the path is not a positive integer.	No – fix the path.
invalid_product_id	400	The productId path segment on GET /v1/products/{productId} does not match the SLO_/SLS_-prefixed shape.	No – fix the path.
invalid_service_type	400	GET /v1/products’s serviceType filter is not one of the values this API can order (STOCK or POD).	No – fix the parameter.
updated_since_not_supported	400	An updatedSince parameter was sent. Rejected rather than ignored, on purpose – see “No updatedSince / no change polling” above.	No – remove the parameter; there is no change-polling mechanism to switch to.
invalid_request	400	POST /v1/orders’s request body failed validation – malformed JSON, a missing or malformed field, an unknown key, or a body-level rule such as partnerLineId uniqueness or a misplaced shipTo – or GET /v1/orders/submissions’s status/limit filter is malformed. detail names the exact violation.	No – fix the request.
invalid_submission_id	400	The submissionId path segment on GET /v1/orders/submissions/{submissionId} is not a well-formed UUID.	No – fix the path.
invalid_quantity	400	The quantity on POST /v1/products/{productId}/quote is missing or not a positive integer.	No – fix the request body.
invalid_shipping_quote_request	400	POST /v1/shipping/quote’s body failed validation – malformed JSON, a missing or mistyped field, an unknown key at the top level or inside shipTo, or a weightOunces outside 0 < w <= 5000000. detail names the field.	No – fix the request body.
invalid_item_number	400	The itemNumber path segment on a proof route is not a positive integer. It is the line’s itemNumber from GET /v1/orders/{orderNumber}/items, never a Collaterate internal id.	No – fix the path.
invalid_token	401	The credential is missing, expired, or invalid.	No – mint a new token, retry once, then investigate the credential.
insufficient_scope	403	The token lacks the scope required for this operation.	No – mint a token with the required scope.
order_not_found	404	No such order, or one that exists outside your granted sites (see above).	No.
order_item_not_found	404	No line matching (orderNumber, itemNumber) resolves for you – absent, outside your granted sites, or hidden from the customer, identically.	No.
product_not_found	404	No such product, or one that exists but belongs to a site outside your granted sites (same rule as order_not_found).	No.
quote_product_not_found	404	The product resolved in our own catalog but Collaterate could not price it. Rare.	No.
template_not_found	404	GET /v1/products/{productId}/template found no Chili template for this product – not TEMPLATE-classified, TEMPLATE-classified with a legacy EDOC/CANVA vendor, or Chili-templated with no document configured. All three identically.	No.
submission_not_found	404	No submission exists with this id for your credential – whether it never existed or belongs to another partner, identically.	No.
ordering_not_provisioned	409	POST /v1/orders’s siteId has no ordering user configured. This is set up per (partner, site) by staff at onboarding; a partner cannot provision it themselves.	No – ask Partner Integrations to provision an ordering user for the site, then retry.
partner_order_id_reused	409	POST /v1/orders’s partnerOrderId was already used, with a request body that does not match this one. Resending the identical body under the same partnerOrderId is safe and returns the original submission (see the operation description); reusing it for a materially different order is rejected instead of silently creating a second order.	No – use a new partnerOrderId, or resend the exact original body to poll the existing submission.
proof_not_pending_review	409	A proof approve or decline was sent for a line whose proofStatus is not PENDING_REVIEW – no proof yet, already decided, or a state this API does not recognise. detail says which. On a RETRY of a decision that already succeeded, this is the expected answer and means success.	No – read the line’s current proofStatus from GET /v1/orders/{orderNumber}/items.
order_item_cancelled	409	A proof approve or decline was sent for a cancelled line. It will never be produced, so its proof cannot be decided.	No.
quote_invalid	422	Collaterate rejected the quote on business-validation grounds (e.g. quantity over the product’s configured maximum). detail carries Collaterate’s own validation message.	No – fix the request body (e.g. reduce quantity).
unknown_country_code	422	POST /v1/shipping/quote’s shipTo.country is not a country code Collaterate recognises.	No – send a code Collaterate carries (US, CA, MX, …).
unknown_state_code	422	POST /v1/shipping/quote’s shipTo.state is not a state or province of the country you sent. State codes are resolved WITHIN the country, since they are not unique across countries.	No – fix the state, or the country it belongs to.
shipping_quote_unavailable	422	POST /v1/shipping/quote produced no priced service at all for that destination and weight. detail carries Collaterate’s own reasons when it gave any – an invalid postal code for the country is the common one – and says so plainly when it did not.	No – fix the destination. An empty result is never returned as a 200.
denial_reason_not_available	422	POST .../proof/decline’s reason is well-formed but is not a denial reason this line’s proof offers – including a code that is valid on a different line, and UNKNOWN, which never is. detail lists what is valid here.	No – pick a code from GET .../proof/denial-reasons for this line.
rate_limit_exceeded	429	Rate limit or daily quota exceeded.	Yes – honor Retry-After.
internal_error	500	Unexpected server-side failure. Detail is always the fixed string below, never the underlying error.	No, or with caution – if persistent, contact Partner Integrations.
service_unavailable	503	Transient failure – typically the database path, but also a Lambda that crashed, timed out, or hit its own concurrency limit before any handler ran.	Yes, with backoff.

Three statuses are answered by the API gateway before your request reaches application code: 401 (authorizer denial), 429 (usage-plan throttle), and 503 (the Lambda integration itself failed). All three are configured to return this same document with the codes above, so one parser and one branch on code covers every error this API produces. The 403 on GET /v1/ping is the sole exception anywhere in the API – it comes from the edge firewall, which is not ours to shape, and carries no problem document.

object

type

required

Always the literal string about:blank today; reserved by RFC 9457 for future use.

string

Allowed value: about:blank

title

required

Short, human-readable summary of the HTTP status (e.g. “Not Found”).

string

status

required

The HTTP status code, repeated in the body for convenience.

integer

code

required

Stable, machine-readable error identifier. Safe to branch on. See the table above.

string

Allowed values: all_segments_visible_reset_not_acknowledged artwork_reservation_not_usable audit_unavailable auto_assigned_segments_present credit_account_not_found cursor_not_supported_with_search denial_reason_not_available division_code_conflict division_create_requires_address division_not_found division_not_on_site division_parent_invalid image_not_found insufficient_scope internal_error invalid_active invalid_adjustment_type invalid_cursor invalid_credit_account_id invalid_division_id invalid_image_id invalid_image_patch invalid_item_number invalid_order_number invalid_product_id invalid_product_patch invalid_quantity invalid_query invalid_request invalid_segment_ids invalid_segments_body invalid_service_type invalid_shipping_quote_request invalid_site_id invalid_submission_id invalid_token invalid_user_id invalid_variant_id invalid_variant_patch monolith_rejected monolith_target_missing null_not_supported order_item_cancelled order_item_not_found order_not_found ordering_not_provisioned parent_is_self parent_not_on_site partner_order_id_reused product_not_found product_write_partially_applied proof_not_pending_review quote_invalid quote_product_not_found rate_limit_exceeded search_not_available segment_not_on_site service_unavailable shipping_quote_unavailable site_id_required_for_search site_not_found sls_null_backfills_master submission_not_found template_not_found unknown_country_code unknown_query_parameter unknown_state_code unsupported_field_for_service_type updated_since_not_supported user_already_exists user_not_found variant_not_site_addressable

detail

required

Human-readable explanation. Do not parse this – it may be reworded without notice.

string

requestId

required

Echoes the request’s id. Include this when contacting Partner Integrations about a specific failed call – it resolves directly to one log entry.

string

Example

{
  "type": "about:blank",
  "code": "all_segments_visible_reset_not_acknowledged"
}

401

Missing, expired, or otherwise invalid credential. Not retryable as-is.

Produced by the API gateway’s authorizer, before the request reaches any application code, so every cause – no Authorization header, a malformed one, a token that is expired, wrongly signed, from the wrong pool, or belongs to a credential that has been disabled – yields this identical response. The gateway is configured to answer in the same application/problem+json shape as everything else, so you do not need a second parser for this status; what it cannot do is tell you which of those causes applied.

Media typeapplication/problem+json

RFC 9457 application/problem+json body. code is the published, stable, machine-readable field to branch your integration logic on – detail is a human-readable string that may be reworded over time and must not be parsed.

This table is the whole published set: every code this API can return appears below, and nothing below is unreachable. test/docs/openapi-matches-reality.test.ts compares the enum to the codes the handlers actually construct, so a code added to one side and not the other fails the build rather than shipping.

Published code values:

code	HTTP status	Meaning	Retry?
invalid_cursor	400	The cursor query parameter could not be decoded.	No – restart pagination with no cursor. Do not resend the same value.
invalid_site_id	400	The siteId filter is not a positive integer, or it names a site outside your grant. detail says which.	No – fix the parameter against GET /v1/me’s grantedSiteIds.
invalid_order_number	400	The order number in the path is not a positive integer.	No – fix the path.
invalid_product_id	400	The productId path segment on GET /v1/products/{productId} does not match the SLO_/SLS_-prefixed shape.	No – fix the path.
invalid_service_type	400	GET /v1/products’s serviceType filter is not one of the values this API can order (STOCK or POD).	No – fix the parameter.
updated_since_not_supported	400	An updatedSince parameter was sent. Rejected rather than ignored, on purpose – see “No updatedSince / no change polling” above.	No – remove the parameter; there is no change-polling mechanism to switch to.
invalid_request	400	POST /v1/orders’s request body failed validation – malformed JSON, a missing or malformed field, an unknown key, or a body-level rule such as partnerLineId uniqueness or a misplaced shipTo – or GET /v1/orders/submissions’s status/limit filter is malformed. detail names the exact violation.	No – fix the request.
invalid_submission_id	400	The submissionId path segment on GET /v1/orders/submissions/{submissionId} is not a well-formed UUID.	No – fix the path.
invalid_quantity	400	The quantity on POST /v1/products/{productId}/quote is missing or not a positive integer.	No – fix the request body.
invalid_shipping_quote_request	400	POST /v1/shipping/quote’s body failed validation – malformed JSON, a missing or mistyped field, an unknown key at the top level or inside shipTo, or a weightOunces outside 0 < w <= 5000000. detail names the field.	No – fix the request body.
invalid_item_number	400	The itemNumber path segment on a proof route is not a positive integer. It is the line’s itemNumber from GET /v1/orders/{orderNumber}/items, never a Collaterate internal id.	No – fix the path.
invalid_token	401	The credential is missing, expired, or invalid.	No – mint a new token, retry once, then investigate the credential.
insufficient_scope	403	The token lacks the scope required for this operation.	No – mint a token with the required scope.
order_not_found	404	No such order, or one that exists outside your granted sites (see above).	No.
order_item_not_found	404	No line matching (orderNumber, itemNumber) resolves for you – absent, outside your granted sites, or hidden from the customer, identically.	No.
product_not_found	404	No such product, or one that exists but belongs to a site outside your granted sites (same rule as order_not_found).	No.
quote_product_not_found	404	The product resolved in our own catalog but Collaterate could not price it. Rare.	No.
template_not_found	404	GET /v1/products/{productId}/template found no Chili template for this product – not TEMPLATE-classified, TEMPLATE-classified with a legacy EDOC/CANVA vendor, or Chili-templated with no document configured. All three identically.	No.
submission_not_found	404	No submission exists with this id for your credential – whether it never existed or belongs to another partner, identically.	No.
ordering_not_provisioned	409	POST /v1/orders’s siteId has no ordering user configured. This is set up per (partner, site) by staff at onboarding; a partner cannot provision it themselves.	No – ask Partner Integrations to provision an ordering user for the site, then retry.
partner_order_id_reused	409	POST /v1/orders’s partnerOrderId was already used, with a request body that does not match this one. Resending the identical body under the same partnerOrderId is safe and returns the original submission (see the operation description); reusing it for a materially different order is rejected instead of silently creating a second order.	No – use a new partnerOrderId, or resend the exact original body to poll the existing submission.
proof_not_pending_review	409	A proof approve or decline was sent for a line whose proofStatus is not PENDING_REVIEW – no proof yet, already decided, or a state this API does not recognise. detail says which. On a RETRY of a decision that already succeeded, this is the expected answer and means success.	No – read the line’s current proofStatus from GET /v1/orders/{orderNumber}/items.
order_item_cancelled	409	A proof approve or decline was sent for a cancelled line. It will never be produced, so its proof cannot be decided.	No.
quote_invalid	422	Collaterate rejected the quote on business-validation grounds (e.g. quantity over the product’s configured maximum). detail carries Collaterate’s own validation message.	No – fix the request body (e.g. reduce quantity).
unknown_country_code	422	POST /v1/shipping/quote’s shipTo.country is not a country code Collaterate recognises.	No – send a code Collaterate carries (US, CA, MX, …).
unknown_state_code	422	POST /v1/shipping/quote’s shipTo.state is not a state or province of the country you sent. State codes are resolved WITHIN the country, since they are not unique across countries.	No – fix the state, or the country it belongs to.
shipping_quote_unavailable	422	POST /v1/shipping/quote produced no priced service at all for that destination and weight. detail carries Collaterate’s own reasons when it gave any – an invalid postal code for the country is the common one – and says so plainly when it did not.	No – fix the destination. An empty result is never returned as a 200.
denial_reason_not_available	422	POST .../proof/decline’s reason is well-formed but is not a denial reason this line’s proof offers – including a code that is valid on a different line, and UNKNOWN, which never is. detail lists what is valid here.	No – pick a code from GET .../proof/denial-reasons for this line.
rate_limit_exceeded	429	Rate limit or daily quota exceeded.	Yes – honor Retry-After.
internal_error	500	Unexpected server-side failure. Detail is always the fixed string below, never the underlying error.	No, or with caution – if persistent, contact Partner Integrations.
service_unavailable	503	Transient failure – typically the database path, but also a Lambda that crashed, timed out, or hit its own concurrency limit before any handler ran.	Yes, with backoff.

Three statuses are answered by the API gateway before your request reaches application code: 401 (authorizer denial), 429 (usage-plan throttle), and 503 (the Lambda integration itself failed). All three are configured to return this same document with the codes above, so one parser and one branch on code covers every error this API produces. The 403 on GET /v1/ping is the sole exception anywhere in the API – it comes from the edge firewall, which is not ours to shape, and carries no problem document.

object

type

required

Always the literal string about:blank today; reserved by RFC 9457 for future use.

string

Allowed value: about:blank

title

required

Short, human-readable summary of the HTTP status (e.g. “Not Found”).

string

status

required

The HTTP status code, repeated in the body for convenience.

integer

code

required

Stable, machine-readable error identifier. Safe to branch on. See the table above.

string

Allowed values: all_segments_visible_reset_not_acknowledged artwork_reservation_not_usable audit_unavailable auto_assigned_segments_present credit_account_not_found cursor_not_supported_with_search denial_reason_not_available division_code_conflict division_create_requires_address division_not_found division_not_on_site division_parent_invalid image_not_found insufficient_scope internal_error invalid_active invalid_adjustment_type invalid_cursor invalid_credit_account_id invalid_division_id invalid_image_id invalid_image_patch invalid_item_number invalid_order_number invalid_product_id invalid_product_patch invalid_quantity invalid_query invalid_request invalid_segment_ids invalid_segments_body invalid_service_type invalid_shipping_quote_request invalid_site_id invalid_submission_id invalid_token invalid_user_id invalid_variant_id invalid_variant_patch monolith_rejected monolith_target_missing null_not_supported order_item_cancelled order_item_not_found order_not_found ordering_not_provisioned parent_is_self parent_not_on_site partner_order_id_reused product_not_found product_write_partially_applied proof_not_pending_review quote_invalid quote_product_not_found rate_limit_exceeded search_not_available segment_not_on_site service_unavailable shipping_quote_unavailable site_id_required_for_search site_not_found sls_null_backfills_master submission_not_found template_not_found unknown_country_code unknown_query_parameter unknown_state_code unsupported_field_for_service_type updated_since_not_supported user_already_exists user_not_found variant_not_site_addressable

detail

required

Human-readable explanation. Do not parse this – it may be reworded without notice.

string

requestId

required

Echoes the request’s id. Include this when contacting Partner Integrations about a specific failed call – it resolves directly to one log entry.

string

Example

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "code": "invalid_token",
  "detail": "The credential presented with this request is missing, expired, or invalid.",
  "requestId": "8f3c1e2a-..."
}

403

The credential is valid but lacks the scope required for this operation (for example, a token minted without partner-api/orders:read). Not retryable as-is – request a token with the required scope. Not to be confused with an out-of-scope order, which is a 404 (see above), or with the edge firewall’s 403 on /ping, which carries no problem document at all.

Media typeapplication/problem+json

RFC 9457 application/problem+json body. code is the published, stable, machine-readable field to branch your integration logic on – detail is a human-readable string that may be reworded over time and must not be parsed.

This table is the whole published set: every code this API can return appears below, and nothing below is unreachable. test/docs/openapi-matches-reality.test.ts compares the enum to the codes the handlers actually construct, so a code added to one side and not the other fails the build rather than shipping.

Published code values:

code	HTTP status	Meaning	Retry?
invalid_cursor	400	The cursor query parameter could not be decoded.	No – restart pagination with no cursor. Do not resend the same value.
invalid_site_id	400	The siteId filter is not a positive integer, or it names a site outside your grant. detail says which.	No – fix the parameter against GET /v1/me’s grantedSiteIds.
invalid_order_number	400	The order number in the path is not a positive integer.	No – fix the path.
invalid_product_id	400	The productId path segment on GET /v1/products/{productId} does not match the SLO_/SLS_-prefixed shape.	No – fix the path.
invalid_service_type	400	GET /v1/products’s serviceType filter is not one of the values this API can order (STOCK or POD).	No – fix the parameter.
updated_since_not_supported	400	An updatedSince parameter was sent. Rejected rather than ignored, on purpose – see “No updatedSince / no change polling” above.	No – remove the parameter; there is no change-polling mechanism to switch to.
invalid_request	400	POST /v1/orders’s request body failed validation – malformed JSON, a missing or malformed field, an unknown key, or a body-level rule such as partnerLineId uniqueness or a misplaced shipTo – or GET /v1/orders/submissions’s status/limit filter is malformed. detail names the exact violation.	No – fix the request.
invalid_submission_id	400	The submissionId path segment on GET /v1/orders/submissions/{submissionId} is not a well-formed UUID.	No – fix the path.
invalid_quantity	400	The quantity on POST /v1/products/{productId}/quote is missing or not a positive integer.	No – fix the request body.
invalid_shipping_quote_request	400	POST /v1/shipping/quote’s body failed validation – malformed JSON, a missing or mistyped field, an unknown key at the top level or inside shipTo, or a weightOunces outside 0 < w <= 5000000. detail names the field.	No – fix the request body.
invalid_item_number	400	The itemNumber path segment on a proof route is not a positive integer. It is the line’s itemNumber from GET /v1/orders/{orderNumber}/items, never a Collaterate internal id.	No – fix the path.
invalid_token	401	The credential is missing, expired, or invalid.	No – mint a new token, retry once, then investigate the credential.
insufficient_scope	403	The token lacks the scope required for this operation.	No – mint a token with the required scope.
order_not_found	404	No such order, or one that exists outside your granted sites (see above).	No.
order_item_not_found	404	No line matching (orderNumber, itemNumber) resolves for you – absent, outside your granted sites, or hidden from the customer, identically.	No.
product_not_found	404	No such product, or one that exists but belongs to a site outside your granted sites (same rule as order_not_found).	No.
quote_product_not_found	404	The product resolved in our own catalog but Collaterate could not price it. Rare.	No.
template_not_found	404	GET /v1/products/{productId}/template found no Chili template for this product – not TEMPLATE-classified, TEMPLATE-classified with a legacy EDOC/CANVA vendor, or Chili-templated with no document configured. All three identically.	No.
submission_not_found	404	No submission exists with this id for your credential – whether it never existed or belongs to another partner, identically.	No.
ordering_not_provisioned	409	POST /v1/orders’s siteId has no ordering user configured. This is set up per (partner, site) by staff at onboarding; a partner cannot provision it themselves.	No – ask Partner Integrations to provision an ordering user for the site, then retry.
partner_order_id_reused	409	POST /v1/orders’s partnerOrderId was already used, with a request body that does not match this one. Resending the identical body under the same partnerOrderId is safe and returns the original submission (see the operation description); reusing it for a materially different order is rejected instead of silently creating a second order.	No – use a new partnerOrderId, or resend the exact original body to poll the existing submission.
proof_not_pending_review	409	A proof approve or decline was sent for a line whose proofStatus is not PENDING_REVIEW – no proof yet, already decided, or a state this API does not recognise. detail says which. On a RETRY of a decision that already succeeded, this is the expected answer and means success.	No – read the line’s current proofStatus from GET /v1/orders/{orderNumber}/items.
order_item_cancelled	409	A proof approve or decline was sent for a cancelled line. It will never be produced, so its proof cannot be decided.	No.
quote_invalid	422	Collaterate rejected the quote on business-validation grounds (e.g. quantity over the product’s configured maximum). detail carries Collaterate’s own validation message.	No – fix the request body (e.g. reduce quantity).
unknown_country_code	422	POST /v1/shipping/quote’s shipTo.country is not a country code Collaterate recognises.	No – send a code Collaterate carries (US, CA, MX, …).
unknown_state_code	422	POST /v1/shipping/quote’s shipTo.state is not a state or province of the country you sent. State codes are resolved WITHIN the country, since they are not unique across countries.	No – fix the state, or the country it belongs to.
shipping_quote_unavailable	422	POST /v1/shipping/quote produced no priced service at all for that destination and weight. detail carries Collaterate’s own reasons when it gave any – an invalid postal code for the country is the common one – and says so plainly when it did not.	No – fix the destination. An empty result is never returned as a 200.
denial_reason_not_available	422	POST .../proof/decline’s reason is well-formed but is not a denial reason this line’s proof offers – including a code that is valid on a different line, and UNKNOWN, which never is. detail lists what is valid here.	No – pick a code from GET .../proof/denial-reasons for this line.
rate_limit_exceeded	429	Rate limit or daily quota exceeded.	Yes – honor Retry-After.
internal_error	500	Unexpected server-side failure. Detail is always the fixed string below, never the underlying error.	No, or with caution – if persistent, contact Partner Integrations.
service_unavailable	503	Transient failure – typically the database path, but also a Lambda that crashed, timed out, or hit its own concurrency limit before any handler ran.	Yes, with backoff.

Three statuses are answered by the API gateway before your request reaches application code: 401 (authorizer denial), 429 (usage-plan throttle), and 503 (the Lambda integration itself failed). All three are configured to return this same document with the codes above, so one parser and one branch on code covers every error this API produces. The 403 on GET /v1/ping is the sole exception anywhere in the API – it comes from the edge firewall, which is not ours to shape, and carries no problem document.

object

type

required

Always the literal string about:blank today; reserved by RFC 9457 for future use.

string

Allowed value: about:blank

title

required

Short, human-readable summary of the HTTP status (e.g. “Not Found”).

string

status

required

The HTTP status code, repeated in the body for convenience.

integer

code

required

Stable, machine-readable error identifier. Safe to branch on. See the table above.

string

Allowed values: all_segments_visible_reset_not_acknowledged artwork_reservation_not_usable audit_unavailable auto_assigned_segments_present credit_account_not_found cursor_not_supported_with_search denial_reason_not_available division_code_conflict division_create_requires_address division_not_found division_not_on_site division_parent_invalid image_not_found insufficient_scope internal_error invalid_active invalid_adjustment_type invalid_cursor invalid_credit_account_id invalid_division_id invalid_image_id invalid_image_patch invalid_item_number invalid_order_number invalid_product_id invalid_product_patch invalid_quantity invalid_query invalid_request invalid_segment_ids invalid_segments_body invalid_service_type invalid_shipping_quote_request invalid_site_id invalid_submission_id invalid_token invalid_user_id invalid_variant_id invalid_variant_patch monolith_rejected monolith_target_missing null_not_supported order_item_cancelled order_item_not_found order_not_found ordering_not_provisioned parent_is_self parent_not_on_site partner_order_id_reused product_not_found product_write_partially_applied proof_not_pending_review quote_invalid quote_product_not_found rate_limit_exceeded search_not_available segment_not_on_site service_unavailable shipping_quote_unavailable site_id_required_for_search site_not_found sls_null_backfills_master submission_not_found template_not_found unknown_country_code unknown_query_parameter unknown_state_code unsupported_field_for_service_type updated_since_not_supported user_already_exists user_not_found variant_not_site_addressable

detail

required

Human-readable explanation. Do not parse this – it may be reworded without notice.

string

requestId

required

Echoes the request’s id. Include this when contacting Partner Integrations about a specific failed call – it resolves directly to one log entry.

string

Example

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "This request requires the \"partner-api/orders:read\" scope.",
  "requestId": "8f3c1e2a-..."
}

404

No such credit account on your granted sites.

Media typeapplication/problem+json

RFC 9457 application/problem+json body. code is the published, stable, machine-readable field to branch your integration logic on – detail is a human-readable string that may be reworded over time and must not be parsed.

This table is the whole published set: every code this API can return appears below, and nothing below is unreachable. test/docs/openapi-matches-reality.test.ts compares the enum to the codes the handlers actually construct, so a code added to one side and not the other fails the build rather than shipping.

Published code values:

code	HTTP status	Meaning	Retry?
invalid_cursor	400	The cursor query parameter could not be decoded.	No – restart pagination with no cursor. Do not resend the same value.
invalid_site_id	400	The siteId filter is not a positive integer, or it names a site outside your grant. detail says which.	No – fix the parameter against GET /v1/me’s grantedSiteIds.
invalid_order_number	400	The order number in the path is not a positive integer.	No – fix the path.
invalid_product_id	400	The productId path segment on GET /v1/products/{productId} does not match the SLO_/SLS_-prefixed shape.	No – fix the path.
invalid_service_type	400	GET /v1/products’s serviceType filter is not one of the values this API can order (STOCK or POD).	No – fix the parameter.
updated_since_not_supported	400	An updatedSince parameter was sent. Rejected rather than ignored, on purpose – see “No updatedSince / no change polling” above.	No – remove the parameter; there is no change-polling mechanism to switch to.
invalid_request	400	POST /v1/orders’s request body failed validation – malformed JSON, a missing or malformed field, an unknown key, or a body-level rule such as partnerLineId uniqueness or a misplaced shipTo – or GET /v1/orders/submissions’s status/limit filter is malformed. detail names the exact violation.	No – fix the request.
invalid_submission_id	400	The submissionId path segment on GET /v1/orders/submissions/{submissionId} is not a well-formed UUID.	No – fix the path.
invalid_quantity	400	The quantity on POST /v1/products/{productId}/quote is missing or not a positive integer.	No – fix the request body.
invalid_shipping_quote_request	400	POST /v1/shipping/quote’s body failed validation – malformed JSON, a missing or mistyped field, an unknown key at the top level or inside shipTo, or a weightOunces outside 0 < w <= 5000000. detail names the field.	No – fix the request body.
invalid_item_number	400	The itemNumber path segment on a proof route is not a positive integer. It is the line’s itemNumber from GET /v1/orders/{orderNumber}/items, never a Collaterate internal id.	No – fix the path.
invalid_token	401	The credential is missing, expired, or invalid.	No – mint a new token, retry once, then investigate the credential.
insufficient_scope	403	The token lacks the scope required for this operation.	No – mint a token with the required scope.
order_not_found	404	No such order, or one that exists outside your granted sites (see above).	No.
order_item_not_found	404	No line matching (orderNumber, itemNumber) resolves for you – absent, outside your granted sites, or hidden from the customer, identically.	No.
product_not_found	404	No such product, or one that exists but belongs to a site outside your granted sites (same rule as order_not_found).	No.
quote_product_not_found	404	The product resolved in our own catalog but Collaterate could not price it. Rare.	No.
template_not_found	404	GET /v1/products/{productId}/template found no Chili template for this product – not TEMPLATE-classified, TEMPLATE-classified with a legacy EDOC/CANVA vendor, or Chili-templated with no document configured. All three identically.	No.
submission_not_found	404	No submission exists with this id for your credential – whether it never existed or belongs to another partner, identically.	No.
ordering_not_provisioned	409	POST /v1/orders’s siteId has no ordering user configured. This is set up per (partner, site) by staff at onboarding; a partner cannot provision it themselves.	No – ask Partner Integrations to provision an ordering user for the site, then retry.
partner_order_id_reused	409	POST /v1/orders’s partnerOrderId was already used, with a request body that does not match this one. Resending the identical body under the same partnerOrderId is safe and returns the original submission (see the operation description); reusing it for a materially different order is rejected instead of silently creating a second order.	No – use a new partnerOrderId, or resend the exact original body to poll the existing submission.
proof_not_pending_review	409	A proof approve or decline was sent for a line whose proofStatus is not PENDING_REVIEW – no proof yet, already decided, or a state this API does not recognise. detail says which. On a RETRY of a decision that already succeeded, this is the expected answer and means success.	No – read the line’s current proofStatus from GET /v1/orders/{orderNumber}/items.
order_item_cancelled	409	A proof approve or decline was sent for a cancelled line. It will never be produced, so its proof cannot be decided.	No.
quote_invalid	422	Collaterate rejected the quote on business-validation grounds (e.g. quantity over the product’s configured maximum). detail carries Collaterate’s own validation message.	No – fix the request body (e.g. reduce quantity).
unknown_country_code	422	POST /v1/shipping/quote’s shipTo.country is not a country code Collaterate recognises.	No – send a code Collaterate carries (US, CA, MX, …).
unknown_state_code	422	POST /v1/shipping/quote’s shipTo.state is not a state or province of the country you sent. State codes are resolved WITHIN the country, since they are not unique across countries.	No – fix the state, or the country it belongs to.
shipping_quote_unavailable	422	POST /v1/shipping/quote produced no priced service at all for that destination and weight. detail carries Collaterate’s own reasons when it gave any – an invalid postal code for the country is the common one – and says so plainly when it did not.	No – fix the destination. An empty result is never returned as a 200.
denial_reason_not_available	422	POST .../proof/decline’s reason is well-formed but is not a denial reason this line’s proof offers – including a code that is valid on a different line, and UNKNOWN, which never is. detail lists what is valid here.	No – pick a code from GET .../proof/denial-reasons for this line.
rate_limit_exceeded	429	Rate limit or daily quota exceeded.	Yes – honor Retry-After.
internal_error	500	Unexpected server-side failure. Detail is always the fixed string below, never the underlying error.	No, or with caution – if persistent, contact Partner Integrations.
service_unavailable	503	Transient failure – typically the database path, but also a Lambda that crashed, timed out, or hit its own concurrency limit before any handler ran.	Yes, with backoff.

Three statuses are answered by the API gateway before your request reaches application code: 401 (authorizer denial), 429 (usage-plan throttle), and 503 (the Lambda integration itself failed). All three are configured to return this same document with the codes above, so one parser and one branch on code covers every error this API produces. The 403 on GET /v1/ping is the sole exception anywhere in the API – it comes from the edge firewall, which is not ours to shape, and carries no problem document.

object

type

required

Always the literal string about:blank today; reserved by RFC 9457 for future use.

string

Allowed value: about:blank

title

required

Short, human-readable summary of the HTTP status (e.g. “Not Found”).

string

status

required

The HTTP status code, repeated in the body for convenience.

integer

code

required

Stable, machine-readable error identifier. Safe to branch on. See the table above.

string

Allowed values: all_segments_visible_reset_not_acknowledged artwork_reservation_not_usable audit_unavailable auto_assigned_segments_present credit_account_not_found cursor_not_supported_with_search denial_reason_not_available division_code_conflict division_create_requires_address division_not_found division_not_on_site division_parent_invalid image_not_found insufficient_scope internal_error invalid_active invalid_adjustment_type invalid_cursor invalid_credit_account_id invalid_division_id invalid_image_id invalid_image_patch invalid_item_number invalid_order_number invalid_product_id invalid_product_patch invalid_quantity invalid_query invalid_request invalid_segment_ids invalid_segments_body invalid_service_type invalid_shipping_quote_request invalid_site_id invalid_submission_id invalid_token invalid_user_id invalid_variant_id invalid_variant_patch monolith_rejected monolith_target_missing null_not_supported order_item_cancelled order_item_not_found order_not_found ordering_not_provisioned parent_is_self parent_not_on_site partner_order_id_reused product_not_found product_write_partially_applied proof_not_pending_review quote_invalid quote_product_not_found rate_limit_exceeded search_not_available segment_not_on_site service_unavailable shipping_quote_unavailable site_id_required_for_search site_not_found sls_null_backfills_master submission_not_found template_not_found unknown_country_code unknown_query_parameter unknown_state_code unsupported_field_for_service_type updated_since_not_supported user_already_exists user_not_found variant_not_site_addressable

detail

required

Human-readable explanation. Do not parse this – it may be reworded without notice.

string

requestId

required

Echoes the request’s id. Include this when contacting Partner Integrations about a specific failed call – it resolves directly to one log entry.

string

Example

{
  "type": "about:blank",
  "code": "all_segments_visible_reset_not_acknowledged"
}

429

Your rate limit or daily quota was exceeded. Retryable – honor the Retry-After header (seconds) before your next attempt.

Like the 401, this comes from the gateway’s usage plan rather than from application code, and is configured to carry the same problem document as every other error so a single parser covers the whole API.

Media typeapplication/problem+json

RFC 9457 application/problem+json body. code is the published, stable, machine-readable field to branch your integration logic on – detail is a human-readable string that may be reworded over time and must not be parsed.

This table is the whole published set: every code this API can return appears below, and nothing below is unreachable. test/docs/openapi-matches-reality.test.ts compares the enum to the codes the handlers actually construct, so a code added to one side and not the other fails the build rather than shipping.

Published code values:

code	HTTP status	Meaning	Retry?
invalid_cursor	400	The cursor query parameter could not be decoded.	No – restart pagination with no cursor. Do not resend the same value.
invalid_site_id	400	The siteId filter is not a positive integer, or it names a site outside your grant. detail says which.	No – fix the parameter against GET /v1/me’s grantedSiteIds.
invalid_order_number	400	The order number in the path is not a positive integer.	No – fix the path.
invalid_product_id	400	The productId path segment on GET /v1/products/{productId} does not match the SLO_/SLS_-prefixed shape.	No – fix the path.
invalid_service_type	400	GET /v1/products’s serviceType filter is not one of the values this API can order (STOCK or POD).	No – fix the parameter.
updated_since_not_supported	400	An updatedSince parameter was sent. Rejected rather than ignored, on purpose – see “No updatedSince / no change polling” above.	No – remove the parameter; there is no change-polling mechanism to switch to.
invalid_request	400	POST /v1/orders’s request body failed validation – malformed JSON, a missing or malformed field, an unknown key, or a body-level rule such as partnerLineId uniqueness or a misplaced shipTo – or GET /v1/orders/submissions’s status/limit filter is malformed. detail names the exact violation.	No – fix the request.
invalid_submission_id	400	The submissionId path segment on GET /v1/orders/submissions/{submissionId} is not a well-formed UUID.	No – fix the path.
invalid_quantity	400	The quantity on POST /v1/products/{productId}/quote is missing or not a positive integer.	No – fix the request body.
invalid_shipping_quote_request	400	POST /v1/shipping/quote’s body failed validation – malformed JSON, a missing or mistyped field, an unknown key at the top level or inside shipTo, or a weightOunces outside 0 < w <= 5000000. detail names the field.	No – fix the request body.
invalid_item_number	400	The itemNumber path segment on a proof route is not a positive integer. It is the line’s itemNumber from GET /v1/orders/{orderNumber}/items, never a Collaterate internal id.	No – fix the path.
invalid_token	401	The credential is missing, expired, or invalid.	No – mint a new token, retry once, then investigate the credential.
insufficient_scope	403	The token lacks the scope required for this operation.	No – mint a token with the required scope.
order_not_found	404	No such order, or one that exists outside your granted sites (see above).	No.
order_item_not_found	404	No line matching (orderNumber, itemNumber) resolves for you – absent, outside your granted sites, or hidden from the customer, identically.	No.
product_not_found	404	No such product, or one that exists but belongs to a site outside your granted sites (same rule as order_not_found).	No.
quote_product_not_found	404	The product resolved in our own catalog but Collaterate could not price it. Rare.	No.
template_not_found	404	GET /v1/products/{productId}/template found no Chili template for this product – not TEMPLATE-classified, TEMPLATE-classified with a legacy EDOC/CANVA vendor, or Chili-templated with no document configured. All three identically.	No.
submission_not_found	404	No submission exists with this id for your credential – whether it never existed or belongs to another partner, identically.	No.
ordering_not_provisioned	409	POST /v1/orders’s siteId has no ordering user configured. This is set up per (partner, site) by staff at onboarding; a partner cannot provision it themselves.	No – ask Partner Integrations to provision an ordering user for the site, then retry.
partner_order_id_reused	409	POST /v1/orders’s partnerOrderId was already used, with a request body that does not match this one. Resending the identical body under the same partnerOrderId is safe and returns the original submission (see the operation description); reusing it for a materially different order is rejected instead of silently creating a second order.	No – use a new partnerOrderId, or resend the exact original body to poll the existing submission.
proof_not_pending_review	409	A proof approve or decline was sent for a line whose proofStatus is not PENDING_REVIEW – no proof yet, already decided, or a state this API does not recognise. detail says which. On a RETRY of a decision that already succeeded, this is the expected answer and means success.	No – read the line’s current proofStatus from GET /v1/orders/{orderNumber}/items.
order_item_cancelled	409	A proof approve or decline was sent for a cancelled line. It will never be produced, so its proof cannot be decided.	No.
quote_invalid	422	Collaterate rejected the quote on business-validation grounds (e.g. quantity over the product’s configured maximum). detail carries Collaterate’s own validation message.	No – fix the request body (e.g. reduce quantity).
unknown_country_code	422	POST /v1/shipping/quote’s shipTo.country is not a country code Collaterate recognises.	No – send a code Collaterate carries (US, CA, MX, …).
unknown_state_code	422	POST /v1/shipping/quote’s shipTo.state is not a state or province of the country you sent. State codes are resolved WITHIN the country, since they are not unique across countries.	No – fix the state, or the country it belongs to.
shipping_quote_unavailable	422	POST /v1/shipping/quote produced no priced service at all for that destination and weight. detail carries Collaterate’s own reasons when it gave any – an invalid postal code for the country is the common one – and says so plainly when it did not.	No – fix the destination. An empty result is never returned as a 200.
denial_reason_not_available	422	POST .../proof/decline’s reason is well-formed but is not a denial reason this line’s proof offers – including a code that is valid on a different line, and UNKNOWN, which never is. detail lists what is valid here.	No – pick a code from GET .../proof/denial-reasons for this line.
rate_limit_exceeded	429	Rate limit or daily quota exceeded.	Yes – honor Retry-After.
internal_error	500	Unexpected server-side failure. Detail is always the fixed string below, never the underlying error.	No, or with caution – if persistent, contact Partner Integrations.
service_unavailable	503	Transient failure – typically the database path, but also a Lambda that crashed, timed out, or hit its own concurrency limit before any handler ran.	Yes, with backoff.

Three statuses are answered by the API gateway before your request reaches application code: 401 (authorizer denial), 429 (usage-plan throttle), and 503 (the Lambda integration itself failed). All three are configured to return this same document with the codes above, so one parser and one branch on code covers every error this API produces. The 403 on GET /v1/ping is the sole exception anywhere in the API – it comes from the edge firewall, which is not ours to shape, and carries no problem document.

object

type

required

Always the literal string about:blank today; reserved by RFC 9457 for future use.

string

Allowed value: about:blank

title

required

Short, human-readable summary of the HTTP status (e.g. “Not Found”).

string

status

required

The HTTP status code, repeated in the body for convenience.

integer

code

required

Stable, machine-readable error identifier. Safe to branch on. See the table above.

string

Allowed values: all_segments_visible_reset_not_acknowledged artwork_reservation_not_usable audit_unavailable auto_assigned_segments_present credit_account_not_found cursor_not_supported_with_search denial_reason_not_available division_code_conflict division_create_requires_address division_not_found division_not_on_site division_parent_invalid image_not_found insufficient_scope internal_error invalid_active invalid_adjustment_type invalid_cursor invalid_credit_account_id invalid_division_id invalid_image_id invalid_image_patch invalid_item_number invalid_order_number invalid_product_id invalid_product_patch invalid_quantity invalid_query invalid_request invalid_segment_ids invalid_segments_body invalid_service_type invalid_shipping_quote_request invalid_site_id invalid_submission_id invalid_token invalid_user_id invalid_variant_id invalid_variant_patch monolith_rejected monolith_target_missing null_not_supported order_item_cancelled order_item_not_found order_not_found ordering_not_provisioned parent_is_self parent_not_on_site partner_order_id_reused product_not_found product_write_partially_applied proof_not_pending_review quote_invalid quote_product_not_found rate_limit_exceeded search_not_available segment_not_on_site service_unavailable shipping_quote_unavailable site_id_required_for_search site_not_found sls_null_backfills_master submission_not_found template_not_found unknown_country_code unknown_query_parameter unknown_state_code unsupported_field_for_service_type updated_since_not_supported user_already_exists user_not_found variant_not_site_addressable

detail

required

Human-readable explanation. Do not parse this – it may be reworded without notice.

string

requestId

required

Echoes the request’s id. Include this when contacting Partner Integrations about a specific failed call – it resolves directly to one log entry.

string

Example

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "code": "rate_limit_exceeded",
  "detail": "The request rate limit has been exceeded. Retry after the indicated delay.",
  "requestId": "8f3c1e2a-..."
}

Headers

Retry-After

integer

Seconds to wait before retrying.

500

An unexpected server-side failure. detail is always the fixed string below and never the underlying error – a database message quoted back to a partner is a disclosure, so nothing is interpolated into it. The requestId resolves to the log entry that does carry the cause; send it to Partner Integrations rather than guessing.

Media typeapplication/problem+json

RFC 9457 application/problem+json body. code is the published, stable, machine-readable field to branch your integration logic on – detail is a human-readable string that may be reworded over time and must not be parsed.

This table is the whole published set: every code this API can return appears below, and nothing below is unreachable. test/docs/openapi-matches-reality.test.ts compares the enum to the codes the handlers actually construct, so a code added to one side and not the other fails the build rather than shipping.

Published code values:

code	HTTP status	Meaning	Retry?
invalid_cursor	400	The cursor query parameter could not be decoded.	No – restart pagination with no cursor. Do not resend the same value.
invalid_site_id	400	The siteId filter is not a positive integer, or it names a site outside your grant. detail says which.	No – fix the parameter against GET /v1/me’s grantedSiteIds.
invalid_order_number	400	The order number in the path is not a positive integer.	No – fix the path.
invalid_product_id	400	The productId path segment on GET /v1/products/{productId} does not match the SLO_/SLS_-prefixed shape.	No – fix the path.
invalid_service_type	400	GET /v1/products’s serviceType filter is not one of the values this API can order (STOCK or POD).	No – fix the parameter.
updated_since_not_supported	400	An updatedSince parameter was sent. Rejected rather than ignored, on purpose – see “No updatedSince / no change polling” above.	No – remove the parameter; there is no change-polling mechanism to switch to.
invalid_request	400	POST /v1/orders’s request body failed validation – malformed JSON, a missing or malformed field, an unknown key, or a body-level rule such as partnerLineId uniqueness or a misplaced shipTo – or GET /v1/orders/submissions’s status/limit filter is malformed. detail names the exact violation.	No – fix the request.
invalid_submission_id	400	The submissionId path segment on GET /v1/orders/submissions/{submissionId} is not a well-formed UUID.	No – fix the path.
invalid_quantity	400	The quantity on POST /v1/products/{productId}/quote is missing or not a positive integer.	No – fix the request body.
invalid_shipping_quote_request	400	POST /v1/shipping/quote’s body failed validation – malformed JSON, a missing or mistyped field, an unknown key at the top level or inside shipTo, or a weightOunces outside 0 < w <= 5000000. detail names the field.	No – fix the request body.
invalid_item_number	400	The itemNumber path segment on a proof route is not a positive integer. It is the line’s itemNumber from GET /v1/orders/{orderNumber}/items, never a Collaterate internal id.	No – fix the path.
invalid_token	401	The credential is missing, expired, or invalid.	No – mint a new token, retry once, then investigate the credential.
insufficient_scope	403	The token lacks the scope required for this operation.	No – mint a token with the required scope.
order_not_found	404	No such order, or one that exists outside your granted sites (see above).	No.
order_item_not_found	404	No line matching (orderNumber, itemNumber) resolves for you – absent, outside your granted sites, or hidden from the customer, identically.	No.
product_not_found	404	No such product, or one that exists but belongs to a site outside your granted sites (same rule as order_not_found).	No.
quote_product_not_found	404	The product resolved in our own catalog but Collaterate could not price it. Rare.	No.
template_not_found	404	GET /v1/products/{productId}/template found no Chili template for this product – not TEMPLATE-classified, TEMPLATE-classified with a legacy EDOC/CANVA vendor, or Chili-templated with no document configured. All three identically.	No.
submission_not_found	404	No submission exists with this id for your credential – whether it never existed or belongs to another partner, identically.	No.
ordering_not_provisioned	409	POST /v1/orders’s siteId has no ordering user configured. This is set up per (partner, site) by staff at onboarding; a partner cannot provision it themselves.	No – ask Partner Integrations to provision an ordering user for the site, then retry.
partner_order_id_reused	409	POST /v1/orders’s partnerOrderId was already used, with a request body that does not match this one. Resending the identical body under the same partnerOrderId is safe and returns the original submission (see the operation description); reusing it for a materially different order is rejected instead of silently creating a second order.	No – use a new partnerOrderId, or resend the exact original body to poll the existing submission.
proof_not_pending_review	409	A proof approve or decline was sent for a line whose proofStatus is not PENDING_REVIEW – no proof yet, already decided, or a state this API does not recognise. detail says which. On a RETRY of a decision that already succeeded, this is the expected answer and means success.	No – read the line’s current proofStatus from GET /v1/orders/{orderNumber}/items.
order_item_cancelled	409	A proof approve or decline was sent for a cancelled line. It will never be produced, so its proof cannot be decided.	No.
quote_invalid	422	Collaterate rejected the quote on business-validation grounds (e.g. quantity over the product’s configured maximum). detail carries Collaterate’s own validation message.	No – fix the request body (e.g. reduce quantity).
unknown_country_code	422	POST /v1/shipping/quote’s shipTo.country is not a country code Collaterate recognises.	No – send a code Collaterate carries (US, CA, MX, …).
unknown_state_code	422	POST /v1/shipping/quote’s shipTo.state is not a state or province of the country you sent. State codes are resolved WITHIN the country, since they are not unique across countries.	No – fix the state, or the country it belongs to.
shipping_quote_unavailable	422	POST /v1/shipping/quote produced no priced service at all for that destination and weight. detail carries Collaterate’s own reasons when it gave any – an invalid postal code for the country is the common one – and says so plainly when it did not.	No – fix the destination. An empty result is never returned as a 200.
denial_reason_not_available	422	POST .../proof/decline’s reason is well-formed but is not a denial reason this line’s proof offers – including a code that is valid on a different line, and UNKNOWN, which never is. detail lists what is valid here.	No – pick a code from GET .../proof/denial-reasons for this line.
rate_limit_exceeded	429	Rate limit or daily quota exceeded.	Yes – honor Retry-After.
internal_error	500	Unexpected server-side failure. Detail is always the fixed string below, never the underlying error.	No, or with caution – if persistent, contact Partner Integrations.
service_unavailable	503	Transient failure – typically the database path, but also a Lambda that crashed, timed out, or hit its own concurrency limit before any handler ran.	Yes, with backoff.

Three statuses are answered by the API gateway before your request reaches application code: 401 (authorizer denial), 429 (usage-plan throttle), and 503 (the Lambda integration itself failed). All three are configured to return this same document with the codes above, so one parser and one branch on code covers every error this API produces. The 403 on GET /v1/ping is the sole exception anywhere in the API – it comes from the edge firewall, which is not ours to shape, and carries no problem document.

object

type

required

Always the literal string about:blank today; reserved by RFC 9457 for future use.

string

Allowed value: about:blank

title

required

Short, human-readable summary of the HTTP status (e.g. “Not Found”).

string

status

required

The HTTP status code, repeated in the body for convenience.

integer

code

required

Stable, machine-readable error identifier. Safe to branch on. See the table above.

string

Allowed values: all_segments_visible_reset_not_acknowledged artwork_reservation_not_usable audit_unavailable auto_assigned_segments_present credit_account_not_found cursor_not_supported_with_search denial_reason_not_available division_code_conflict division_create_requires_address division_not_found division_not_on_site division_parent_invalid image_not_found insufficient_scope internal_error invalid_active invalid_adjustment_type invalid_cursor invalid_credit_account_id invalid_division_id invalid_image_id invalid_image_patch invalid_item_number invalid_order_number invalid_product_id invalid_product_patch invalid_quantity invalid_query invalid_request invalid_segment_ids invalid_segments_body invalid_service_type invalid_shipping_quote_request invalid_site_id invalid_submission_id invalid_token invalid_user_id invalid_variant_id invalid_variant_patch monolith_rejected monolith_target_missing null_not_supported order_item_cancelled order_item_not_found order_not_found ordering_not_provisioned parent_is_self parent_not_on_site partner_order_id_reused product_not_found product_write_partially_applied proof_not_pending_review quote_invalid quote_product_not_found rate_limit_exceeded search_not_available segment_not_on_site service_unavailable shipping_quote_unavailable site_id_required_for_search site_not_found sls_null_backfills_master submission_not_found template_not_found unknown_country_code unknown_query_parameter unknown_state_code unsupported_field_for_service_type updated_since_not_supported user_already_exists user_not_found variant_not_site_addressable

detail

required

Human-readable explanation. Do not parse this – it may be reworded without notice.

string

requestId

required

Echoes the request’s id. Include this when contacting Partner Integrations about a specific failed call – it resolves directly to one log entry.

string

Example

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "code": "internal_error",
  "detail": "An unexpected error occurred.",
  "requestId": "8f3c1e2a-..."
}

503

Transient failure in the service or the database it reads from (for example, the Aurora reader could not be reached in time), or the request never reached application code at all because the Lambda behind it crashed, timed out, or hit its own concurrency limit. Retryable, with backoff.

Media typeapplication/problem+json

RFC 9457 application/problem+json body. code is the published, stable, machine-readable field to branch your integration logic on – detail is a human-readable string that may be reworded over time and must not be parsed.

This table is the whole published set: every code this API can return appears below, and nothing below is unreachable. test/docs/openapi-matches-reality.test.ts compares the enum to the codes the handlers actually construct, so a code added to one side and not the other fails the build rather than shipping.

Published code values:

code	HTTP status	Meaning	Retry?
invalid_cursor	400	The cursor query parameter could not be decoded.	No – restart pagination with no cursor. Do not resend the same value.
invalid_site_id	400	The siteId filter is not a positive integer, or it names a site outside your grant. detail says which.	No – fix the parameter against GET /v1/me’s grantedSiteIds.
invalid_order_number	400	The order number in the path is not a positive integer.	No – fix the path.
invalid_product_id	400	The productId path segment on GET /v1/products/{productId} does not match the SLO_/SLS_-prefixed shape.	No – fix the path.
invalid_service_type	400	GET /v1/products’s serviceType filter is not one of the values this API can order (STOCK or POD).	No – fix the parameter.
updated_since_not_supported	400	An updatedSince parameter was sent. Rejected rather than ignored, on purpose – see “No updatedSince / no change polling” above.	No – remove the parameter; there is no change-polling mechanism to switch to.
invalid_request	400	POST /v1/orders’s request body failed validation – malformed JSON, a missing or malformed field, an unknown key, or a body-level rule such as partnerLineId uniqueness or a misplaced shipTo – or GET /v1/orders/submissions’s status/limit filter is malformed. detail names the exact violation.	No – fix the request.
invalid_submission_id	400	The submissionId path segment on GET /v1/orders/submissions/{submissionId} is not a well-formed UUID.	No – fix the path.
invalid_quantity	400	The quantity on POST /v1/products/{productId}/quote is missing or not a positive integer.	No – fix the request body.
invalid_shipping_quote_request	400	POST /v1/shipping/quote’s body failed validation – malformed JSON, a missing or mistyped field, an unknown key at the top level or inside shipTo, or a weightOunces outside 0 < w <= 5000000. detail names the field.	No – fix the request body.
invalid_item_number	400	The itemNumber path segment on a proof route is not a positive integer. It is the line’s itemNumber from GET /v1/orders/{orderNumber}/items, never a Collaterate internal id.	No – fix the path.
invalid_token	401	The credential is missing, expired, or invalid.	No – mint a new token, retry once, then investigate the credential.
insufficient_scope	403	The token lacks the scope required for this operation.	No – mint a token with the required scope.
order_not_found	404	No such order, or one that exists outside your granted sites (see above).	No.
order_item_not_found	404	No line matching (orderNumber, itemNumber) resolves for you – absent, outside your granted sites, or hidden from the customer, identically.	No.
product_not_found	404	No such product, or one that exists but belongs to a site outside your granted sites (same rule as order_not_found).	No.
quote_product_not_found	404	The product resolved in our own catalog but Collaterate could not price it. Rare.	No.
template_not_found	404	GET /v1/products/{productId}/template found no Chili template for this product – not TEMPLATE-classified, TEMPLATE-classified with a legacy EDOC/CANVA vendor, or Chili-templated with no document configured. All three identically.	No.
submission_not_found	404	No submission exists with this id for your credential – whether it never existed or belongs to another partner, identically.	No.
ordering_not_provisioned	409	POST /v1/orders’s siteId has no ordering user configured. This is set up per (partner, site) by staff at onboarding; a partner cannot provision it themselves.	No – ask Partner Integrations to provision an ordering user for the site, then retry.
partner_order_id_reused	409	POST /v1/orders’s partnerOrderId was already used, with a request body that does not match this one. Resending the identical body under the same partnerOrderId is safe and returns the original submission (see the operation description); reusing it for a materially different order is rejected instead of silently creating a second order.	No – use a new partnerOrderId, or resend the exact original body to poll the existing submission.
proof_not_pending_review	409	A proof approve or decline was sent for a line whose proofStatus is not PENDING_REVIEW – no proof yet, already decided, or a state this API does not recognise. detail says which. On a RETRY of a decision that already succeeded, this is the expected answer and means success.	No – read the line’s current proofStatus from GET /v1/orders/{orderNumber}/items.
order_item_cancelled	409	A proof approve or decline was sent for a cancelled line. It will never be produced, so its proof cannot be decided.	No.
quote_invalid	422	Collaterate rejected the quote on business-validation grounds (e.g. quantity over the product’s configured maximum). detail carries Collaterate’s own validation message.	No – fix the request body (e.g. reduce quantity).
unknown_country_code	422	POST /v1/shipping/quote’s shipTo.country is not a country code Collaterate recognises.	No – send a code Collaterate carries (US, CA, MX, …).
unknown_state_code	422	POST /v1/shipping/quote’s shipTo.state is not a state or province of the country you sent. State codes are resolved WITHIN the country, since they are not unique across countries.	No – fix the state, or the country it belongs to.
shipping_quote_unavailable	422	POST /v1/shipping/quote produced no priced service at all for that destination and weight. detail carries Collaterate’s own reasons when it gave any – an invalid postal code for the country is the common one – and says so plainly when it did not.	No – fix the destination. An empty result is never returned as a 200.
denial_reason_not_available	422	POST .../proof/decline’s reason is well-formed but is not a denial reason this line’s proof offers – including a code that is valid on a different line, and UNKNOWN, which never is. detail lists what is valid here.	No – pick a code from GET .../proof/denial-reasons for this line.
rate_limit_exceeded	429	Rate limit or daily quota exceeded.	Yes – honor Retry-After.
internal_error	500	Unexpected server-side failure. Detail is always the fixed string below, never the underlying error.	No, or with caution – if persistent, contact Partner Integrations.
service_unavailable	503	Transient failure – typically the database path, but also a Lambda that crashed, timed out, or hit its own concurrency limit before any handler ran.	Yes, with backoff.

Three statuses are answered by the API gateway before your request reaches application code: 401 (authorizer denial), 429 (usage-plan throttle), and 503 (the Lambda integration itself failed). All three are configured to return this same document with the codes above, so one parser and one branch on code covers every error this API produces. The 403 on GET /v1/ping is the sole exception anywhere in the API – it comes from the edge firewall, which is not ours to shape, and carries no problem document.

object

type

required

Always the literal string about:blank today; reserved by RFC 9457 for future use.

string

Allowed value: about:blank

title

required

Short, human-readable summary of the HTTP status (e.g. “Not Found”).

string

status

required

The HTTP status code, repeated in the body for convenience.

integer

code

required

Stable, machine-readable error identifier. Safe to branch on. See the table above.

string

Allowed values: all_segments_visible_reset_not_acknowledged artwork_reservation_not_usable audit_unavailable auto_assigned_segments_present credit_account_not_found cursor_not_supported_with_search denial_reason_not_available division_code_conflict division_create_requires_address division_not_found division_not_on_site division_parent_invalid image_not_found insufficient_scope internal_error invalid_active invalid_adjustment_type invalid_cursor invalid_credit_account_id invalid_division_id invalid_image_id invalid_image_patch invalid_item_number invalid_order_number invalid_product_id invalid_product_patch invalid_quantity invalid_query invalid_request invalid_segment_ids invalid_segments_body invalid_service_type invalid_shipping_quote_request invalid_site_id invalid_submission_id invalid_token invalid_user_id invalid_variant_id invalid_variant_patch monolith_rejected monolith_target_missing null_not_supported order_item_cancelled order_item_not_found order_not_found ordering_not_provisioned parent_is_self parent_not_on_site partner_order_id_reused product_not_found product_write_partially_applied proof_not_pending_review quote_invalid quote_product_not_found rate_limit_exceeded search_not_available segment_not_on_site service_unavailable shipping_quote_unavailable site_id_required_for_search site_not_found sls_null_backfills_master submission_not_found template_not_found unknown_country_code unknown_query_parameter unknown_state_code unsupported_field_for_service_type updated_since_not_supported user_already_exists user_not_found variant_not_site_addressable

detail

required

Human-readable explanation. Do not parse this – it may be reworded without notice.

string

requestId

required

Echoes the request’s id. Include this when contacting Partner Integrations about a specific failed call – it resolves directly to one log entry.

string

Example

{
  "type": "about:blank",
  "title": "Service Unavailable",
  "status": 503,
  "code": "service_unavailable",
  "detail": "The service is temporarily unavailable. Please retry.",
  "requestId": "8f3c1e2a-..."
}