Fetchply Docs
API reference

Get a cash-on-delivery confirmation

GET
/api/v1/agents/{id}/cod-confirmations/{confirmationId}

Read one cash-on-delivery confirmation: its order reference, state, decision time, any requested change, and any accepted add-on amount. Buyer phone numbers are never returned. Requires the read:cod permission.

Authorization

BearerAuth read:cod
AuthorizationBearer <token>

In: header

Scope: read:cod

Path Parameters

id*string
confirmationId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/agents/string/cod-confirmations/string"
{
  "id": "c7f1a2b3-4d5e-6f70-8192-a3b4c5d6e7f8",
  "agentId": "a1b2c3d4e5",
  "orderNumber": "#1042",
  "orderId": "gid://shopify/Order/5544332211",
  "status": "confirmed",
  "suppressedReason": null,
  "currency": "PKR",
  "orderTotal": "2499.00",
  "changeRequest": null,
  "upsellRevenueMinor": 89900,
  "remindersSent": 1,
  "orderPlacedAt": "2026-08-15T10:00:00.000Z",
  "firstContactedAt": "2026-08-15T10:00:12.000Z",
  "decidedAt": "2026-08-15T10:41:03.000Z",
  "createdAt": "2026-08-15T10:00:05.000Z"
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

Cash-on-delivery metrics GET

Outcome counts, upsell revenue per currency, the estimated shipping cost avoided, a daily trend, and why any confirmations never reached a customer. Defaults to the trailing 30 days. `shippingSaved.estimatedMinor` is null when the store has not supplied an average shipping cost — treat that as unknown, not zero. Requires the `read:cod` permission.

Get account usage GET

Plan, message credits used against the monthly allowance, remaining add-on message balance, subscription status, and days until the period resets. Requires the `read:usage` permission.