Get Purchase Order Statistics

GET 
/api/spscommerce/:integrationInstance/purchase-orders/metrics

Get statistics and metrics for purchase orders.

Not yet available to API tokens

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

Response:

• pending - Count of pending POs
• unmapped - Count of unmapped POs
• failed - Count of failed POs
• success_rate - Success rate percentage
• new_today - Count of POs received today
• total_amount - Total value of orders
• avg_line_items - Average line items per order

Request

Responses

200

Successful response

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.

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.